diff options
| author | Jesse Plamondon-Willard <github@jplamondonw.com> | 2016-10-19 14:46:23 -0400 |
|---|---|---|
| committer | Jesse Plamondon-Willard <github@jplamondonw.com> | 2016-10-19 14:46:23 -0400 |
| commit | c6dbad2594620f9c25e7e548b813522c1e6c626d (patch) | |
| tree | ce12cbe8ae984893f8ea2ea506108946eeb3e740 /README.md | |
| parent | 9be620e2fcdc13c6e6a918323157e21e1fed568f (diff) | |
| download | SMAPI-c6dbad2594620f9c25e7e548b813522c1e6c626d.tar.gz SMAPI-c6dbad2594620f9c25e7e548b813522c1e6c626d.tar.bz2 SMAPI-c6dbad2594620f9c25e7e548b813522c1e6c626d.zip | |
add license + readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 00000000..6ea731d1 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +**Stardew.ModBuildConfig** is an open-source NuGet package which automates the build configuration +for crossplatform [Stardew Valley](http://stardewvalley.net/) mods that use SMAPI. + +The configuration detects the operating system (Linux, Mac, or Windows) and the Stardew Valley +install path, and injects the correct references to Stardew Valley, SMAPI, and XNA/MonoGame. +It also adds a `GamePath` variable which can be used to automate mod installation during testing +if desired. + +## Contents +* [Installation](#installation) +* [Configuration](#configuration) +* [Versions](#versions) +* [See also](#see-also) + +## Installation +### New mod +_TODO_ + +### Migrating an existing mod +_TODO_ + +## Configuration +_TODO_ + +## Versions +_TODO_ + +## See also +_TODO_ +* <s>NuGet package</s> +* <s>Discussion thread</s>
\ No newline at end of file |