Merge branch 'develop'

1 files changed, 38 insertions, 59 deletions

diff --git a/README.md b/README.md
index f472049c..c5e01c91 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,6 @@ The package...
   only_).
 * packages the mod automatically into the game's mod folder when you build the code (_optional_).
 
-
 ## Contents
 * [Install](#install)
 * [Simplify mod development](#simplify-mod-development)
@@ -32,54 +31,43 @@ The package...
 3. Compile on any platform.
 
 ## Simplify mod development
-### Package your mod into the game directory automatically
-During development, it's helpful to have the mod files packaged into your `Mods` directory automatically each time you build. To do that:
+### Package your mod into the game folder automatically
+You can copy your mod files into the `Mods` folder automatically each time you build, so you don't
+need to do it manually:
 
 1. Edit your mod's `.csproj` file.
-2. Add this block of code at the bottom, right above the closing `</Project>` tag:
-
-   ```xml
-   <Target Name="AfterBuild">
-      <PropertyGroup>
-         <ModPath>$(GamePath)\Mods\$(TargetName)</ModPath>
-      </PropertyGroup>
-      <Copy SourceFiles="$(TargetDir)\$(TargetName).dll" DestinationFolder="$(ModPath)" />
-      <Copy SourceFiles="$(TargetDir)\$(TargetName).pdb" DestinationFolder="$(ModPath)" Condition="Exists('$(TargetDir)\$(TargetName).pdb')" />
-      <Copy SourceFiles="$(TargetDir)\$(TargetName).dll.mdb" DestinationFolder="$(ModPath)" Condition="Exists('$(TargetDir)\$(TargetName).dll.mdb')" />
-      <Copy SourceFiles="$(ProjectDir)manifest.json" DestinationFolder="$(ModPath)" />
-   </Target>
-   ```
-3. Optionally, edit the `<ModPath>` value to change the name, or add any additional files your mod needs.
-
-That's it! Each time you build, the files in `<game path>\Mods\<mod name>` will be updated.
+2. Add this block under the `<Project` line:
+
+     ```xml
+     <PropertyGroup>
+       <DeployModFolderName>$(MSBuildProjectName)</DeployModFolderName>
+     </PropertyGroup>
+     ```
+
+That's it! Each time you build, the files in `<game path>\Mods\<mod name>` will be updated with
+your `manifest.json`, build output, and any `i18n` files.
+
+Notes:
+* To add custom files, just [add them to the build output](https://stackoverflow.com/a/10828462/262123).
+* To customise the folder name, just replace `$(MSBuildProjectName)` with the folder name you want.
+* If your project references another mod, make sure the reference is [_not_ marked 'copy local'](https://msdn.microsoft.com/en-us/library/t1zz5y8c(v=vs.100).aspx).
 
 ### Debug into the mod code
-Stepping into your mod code when the game is running is straightforward, since this package injects the configuration automatically. To do it:
+Stepping into your mod code when the game is running is straightforward, since this package injects
+the configuration automatically. To do it:
 
-1. [Package your mod into the game directory automatically](#package-your-mod-into-the-game-directory-automatically).
+1. [Package your mod into the game folder automatically](#package-your-mod-into-the-game-folder-automatically).
 2. Launch the project with debugging in Visual Studio or MonoDevelop.
 
-This will deploy your mod files into the game directory, launch SMAPI, and attach a debugger automatically. Now you can step through your code, set breakpoints, etc.
+This will deploy your mod files into the game folder, launch SMAPI, and attach a debugger
+automatically. Now you can step through your code, set breakpoints, etc.
 
 ## Troubleshoot
 ### "Failed to find the game install path"
 That error means the package couldn't figure out where the game is installed. You need to specify
 the game location yourself. There's two ways to do that:
 
-* **Option 1: set the path in the project file.**  
-  _(You'll need to do it for every project that uses the package.)_
-  1. Get the folder path containing the Stardew Valley `.exe` file.
-  2. Add this to your `.csproj` file under the `<Project` line:
-
-     ```xml
-     <PropertyGroup>
-       <GamePath>PATH_HERE</GamePath>
-     </PropertyGroup>
-     ```
-
-  3. Replace `PATH_HERE` with your custom game install path.
-
-* **Option 2: set the path globally.**  
+* **Option 1: set the path globally.**  
   _This will apply to every project that uses version 1.5+ of package._
 
   1. Get the full folder path containing the Stardew Valley executable.
@@ -102,30 +90,21 @@ the game location yourself. There's two ways to do that:
 
   4. Replace `PATH_HERE` with your custom game install path.
 
-The configuration will check your custom path first, then fall back to the default paths (so it'll
-still compile on a different computer).
-
-## Versions
-1.5 (upcoming):
-* Added support for setting a custom game path globally.
-* Added default GOG path on Mac.
-
-1.4:
-* Fixed detection of non-default game paths on 32-bit Windows.
-* Removed support for SilVerPLuM (discontinued).
-* Removed support for overriding the target platform (no longer needed since SMAPI crossplatforms mods automatically).
+* **Option 2: set the path in the project file.**  
+  _(You'll need to do it for every project that uses the package.)_
+  1. Get the folder path containing the Stardew Valley `.exe` file.
+  2. Add this to your `.csproj` file under the `<Project` line:
 
-1.3:
-* Added support for non-default game paths on Windows.
+     ```xml
+     <PropertyGroup>
+       <GamePath>PATH_HERE</GamePath>
+     </PropertyGroup>
+     ```
 
-1.2:
-* Exclude game binaries from mod build output.
+  3. Replace `PATH_HERE` with your custom game install path.
 
-1.1:
-* Added support for overriding the target platform.
+The configuration will check your custom path first, then fall back to the default paths (so it'll
+still compile on a different computer).
 
-1.0:
-* Initial release.
-* Added support for detecting the game path automatically.
-* Added support for injecting XNA/MonoGame references automatically based on the OS.
-* Added support for mod builders like SilVerPLuM.
+## Versions
+See [release notes](release-notes.md).