summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2016-11-06 11:15:46 -0500
committerJesse Plamondon-Willard <github@jplamondonw.com>2016-11-06 11:15:46 -0500
commit956e477edb515953e71d1cce1a728284f6ce3cc0 (patch)
treec24db349e8d9d9c42c0258b83a07aad217904984 /README.md
parente4d6cc138129153d654f43aabed16d2ba482beee (diff)
downloadSMAPI-956e477edb515953e71d1cce1a728284f6ce3cc0.tar.gz
SMAPI-956e477edb515953e71d1cce1a728284f6ce3cc0.tar.bz2
SMAPI-956e477edb515953e71d1cce1a728284f6ce3cc0.zip
add developer mode which shows all deprecation warnings, update release process (#165)
Diffstat (limited to 'README.md')
-rw-r--r--README.md67
1 files changed, 37 insertions, 30 deletions
diff --git a/README.md b/README.md
index 87b2669b..a0071c61 100644
--- a/README.md
+++ b/README.md
@@ -37,9 +37,8 @@ placed in a `bin` directory at the root of the git repository.
### Preparing a release
To prepare a crossplatform SMAPI release, you'll need to compile it on two platforms. See
_[crossplatforming a SMAPI mod](http://canimod.com/guides/crossplatforming-a-smapi-mod#preparing-a-mod-release)_
-for the first-time setup.
-
-For simplicity, all paths are relative to the root of the repository (the directory containing `src`).
+for the first-time setup. For simplicity, all paths are relative to the root of the repository (the
+directory containing `src`).
1. Update the version number in `AssemblyInfo.cs` and `Constants::Version`. Make sure you use a
[semantic version](http://semver.org). Recommended format:
@@ -52,35 +51,43 @@ For simplicity, all paths are relative to the root of the repository (the direct
2. In Windows:
1. Rebuild the solution in _Release_ mode.
- 2. Transfer the `bin/Release/~Package` directory to Linux or Mac.
+ 2. Rename `bin/Packaged` to `SMAPI-<version>` (e.g. `SMAPI-1.0`).
+ 2. Transfer the `SMAPI-<version>` directory to Linux or Mac.
_This adds the installer executable and Windows files. We'll do the rest in Linux or Mac,
since we need to set Unix file permissions that Windows won't save._
2. In Linux or Mac:
1. Rebuild the solution in _Release_ mode.
- 2. Copy `bin/Release/~Package/Mono` into the package directory you transferred from Windows.
- 3. Open a terminal in your package directory and run `chmod 755 Mono/StardewModdingAPI`.
- 4. Rename your package directory to `SMAPI-<version>-installer`.
- 5. Compress it into a `SMAPI-<version>.zip` file.
-
-If you did everything right, you should have a release file like this:
-
-```
-SMAPI-1.0.zip
- SMAPI-1.0-installer/
- Mono/
- Mods/*
- Newtonsoft.Json.dll
- StardewModdingAPI
- StardewModdingAPI.exe
- StardewModdingAPI.exe.mdb
- System.Numerics.dll
- steam_appid.txt
- Windows/
- Mods/*
- StardewModdingAPI.exe
- StardewModdingAPI.pdb
- steam_appid.txt
- install.exe
- readme.txt
-```
+ 2. Copy `bin/Packaged/Mono` into the `SMAPI-<version>` directory.
+ 3. If you did everything right so far, you should have a directory like this:
+
+ ```
+ SMAPI-1.0/
+ Mono/
+ Mods/*
+ Newtonsoft.Json.dll
+ StardewModdingAPI
+ StardewModdingAPI.exe
+ StardewModdingAPI.exe.mdb
+ StardewModdingAPI.xml
+ StardewModdingAPI-settings.json
+ System.Numerics.dll
+ steam_appid.txt
+ Windows/
+ Mods/*
+ StardewModdingAPI.exe
+ StardewModdingAPI.pdb
+ StardewModdingAPI.xml
+ StardewModdingAPI-settings.json
+ steam_appid.txt
+ install.exe
+ readme.txt
+ ```
+ 4. Open a terminal in the `SMAPI-<version>` directory and run `chmod 755 Mono/StardewModdingAPI`.
+ 5. Copy & paste the `SMAPI-<version>` directory as `SMAPI-<version>-for-developers`.
+ 6. In the `SMAPI-<version>` directory, delete the following files:
+ * `Mono/StardewModdingAPI.xml`
+ * `Mono/StardewModdingAPI-settings.json`
+ * `Windows/StardewModdingAPI.xml`
+ * `Windows/StardewModdingAPI-settings.json`
+ 7. Compress the two folders into `SMAPI-<version>.zip` and `SMAPI-<version>-for-developers.zip`. \ No newline at end of file