From 741796a4f82146f0130fb6965bf03742497458d7 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Tue, 16 May 2017 23:29:56 -0400 Subject: document compile flags in readme --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index dcb4310f..618f2e9d 100644 --- a/README.md +++ b/README.md @@ -157,3 +157,13 @@ argument | purpose -------- | ------- `--log-path "path"` | The relative or absolute path of the log file SMAPI should write. `--no-terminal` | SMAPI won't write anything to the console window. (Messages will still be written to the log file.) + +### Compile flags +SMAPI uses a small number of conditional compilation constants, which you can set by editing the +`` element in `StardewModdingAPI.csproj`. Supported constants: + +flag | purpose +---- | ------- +`EXPERIMENTAL` | Enables preview features that aren't officially released yet. +`SMAPI_FOR_WINDOWS` | Indicates that SMAPI is being compiled on Windows for players on Windows. Set automatically in `crossplatform.targets`. + -- cgit