Create README.md

README.md

@@ -0,0 +1,26 @@
+Downloads: https://github.com/CnCNet/yrpp-spawner/releases
+
+Building manually
+-----------------
+
+0. Install **Visual Studio** (2019 is recommended, 2017 is minimum) with the dependencies listed in `.vsconfig` (it will prompt you to install missing dependences when you open the project, or you can run VS installer and import the config). If you prefer to use **Visual Studio Code** you may install **VS Build Tools** with the dependencies from `.vsconfig` instead. Not using a code editor or IDE and building via **command line scripts** included with the project is also an option.
+1. Clone this repo recursively via your favorite git client (that will also clone YRpp).
+2. To build the extension:
+   - in Visual Studio: open the solution file in VS and build it (`Debug` build config is recommended);
+   - in VSCode: open the project folder and hit `Run Build Task...` (`Ctrl + Shift + B`);
+   - barebones: run `scripts/build_debug.bat`.
+3. Upon build completion the resulting `cncnet5.dll` and `cncnet5.pdb` would be placed in the subfolder identical to the name of the buildconfig executed.
+
+Credits
+-------
+- **[Belonit](https://github.com/Belonit)** - Porting and adapting
+- **[CnCNet](https://github.com/CnCNet) Contributors** - the [original spawner](https://github.com/CnCNet/yr-patches)
+- **[Ares](https://github.com/Ares-Developers/Ares) and [Phobos](https://github.com/Phobos-developers/Phobos) Contributors** - [YRpp](https://github.com/Phobos-developers/yrpp) and [Syringe](https://github.com/Ares-Developers/Syringe) which are used and some code snippets
+
+Legal and License
+-----
+[![GPL v3](https://www.gnu.org/graphics/gplv3-127x51.png)](https://opensource.org/licenses/GPL-3.0)
+
+This project is an unofficial open-source community collaboration project to extend the Red Alert 2 Yuri's Revenge engine for modding and compatibility purposes.
+
+This project has no direct affiliation with Electronic Arts Inc. Command & Conquer, Command & Conquer Red Alert 2, Command & Conquer Yuri's Revenge are registered trademarks of Electronic Arts Inc. All Rights Reserved.