summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2018-06-30 14:54:15 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2018-06-30 14:54:15 -0400
commit4b646e4f927f4c44004b3b233b6be055a645b563 (patch)
treef21af67cbdae574a51f873984ed246f7eb8a1245 /docs
parent79ad322a8e31e977e455817469427f9c3cf218fd (diff)
downloadSMAPI-4b646e4f927f4c44004b3b233b6be055a645b563.tar.gz
SMAPI-4b646e4f927f4c44004b3b233b6be055a645b563.tar.bz2
SMAPI-4b646e4f927f4c44004b3b233b6be055a645b563.zip
generalise NuGet package's non-mod project feature (#555)
Diffstat (limited to 'docs')
-rw-r--r--docs/mod-build-config.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md
index 32762580..0c1cc10a 100644
--- a/docs/mod-build-config.md
+++ b/docs/mod-build-config.md
@@ -131,18 +131,20 @@ If you don't want to include a file in the mod folder or release zip:
This is a comma-delimited list of regular expression patterns. If any pattern matches a file's
relative path in your mod folder, that file won't be included.
-### Unit test projects
+### Non-mod projects
**(upcoming in 2.1)**
-You can use the package in unit test projects too. Its optional unit test mode...
+You can use the package in non-mod projects too (e.g. unit tests or framework DLLs). You'll need to
+disable deploying the mod and creating a release zip:
-1. disables deploying the project as a mod;
-2. disables creating a release zip;
-2. and copies the referenced DLLs into the build output for unit test frameworks.
+```xml
+<EnableModDeploy>False</EnableModDeploy>
+<EnableModZip>False</EnableModZip>
+```
-To enable it, add this above the first `</PropertyGroup>` in your `.csproj`:
+If this is for unit tests, you may need to copy the referenced DLLs into your build output too:
```xml
-<ModUnitTests>True</ModUnitTests>
+<CopyModReferencesToBuildOutput>True</CopyModReferencesToBuildOutput>
```
## Code warnings