From c6dbad2594620f9c25e7e548b813522c1e6c626d Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Wed, 19 Oct 2016 14:46:23 -0400 Subject: add license + readme --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md (limited to 'README.md') 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_ +* NuGet package +* Discussion thread \ No newline at end of file -- cgit