add readme

README.md

@@ -0,0 +1,32 @@
+# Butterfly Pins
+
+## Requirements for the solution
+
+- .NET 8 SDK for 1.21
+- .NET 10 SDK when building `Version22` for 1.22
+- Vintage Story install - 1.21 or 1.22, with environment variables describing the paths
+- env vars described below
+
+### Required env vars
+
+- `VINTAGE_STORY_21`: path to the 1.21 game install (on Windows default is `%appdata%/VintageStory`)
+- `VINTAGE_STORY_DATA_21`: path to the 1.21 game data directory (on Windows default is `%appdata%/VintageStoryData`)
+- `VINTAGE_STORY_22`: path to the 1.22 game install (`Version22` configuration)
+- `VINTAGE_STORY_DATA_22`: path to the 1.22 game data directory (`Version22` configuration)
+- `VS_CONFIGLIB`: path to `configlib.dll`. If not set, will compile with a warning and without configlib support
+
+## Running
+
+If you know what you're doing, `dotnet build` etc obviously will work. This was created with the official mod template.
+
+### VS Code with `C# Dev Kit` extension
+
+- select appropriate solution configuration: `F1` (run command) -> `.NET: Select a configuration`
+- for 1.21 select `Debug` or `Release`, for 1.22 select `Version22`
+- run action `Start debugging` or `Start without debugging` (might be `f5` and `ctrl+f5` by default)
+
+### Visual Studio
+
+- use configuration picker at the top - `Debug` or `Release` for 1.21, `Version22` for 1.22
+- set ButterflyPins project as the startup project
+- run