From 803987c209a10e28b95cf41c8f86e15a14282db6 Mon Sep 17 00:00:00 2001 From: Miepee Date: Fri, 20 Oct 2023 13:26:21 +0200 Subject: [PATCH] Add compilation instructions. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 07977af..706b48a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Usage: The API/Schema for the input json file will soon be documented. +# Compilation +This project uses git submodules. So before compiling, please ensure you have cloned them (either by doing `git clone --recursive https://github.com/randovania/YAMS`, or if you have already cloned the repo, `git submodule update --init`). +After that, you can use the standard dotnet compilation step: `dotnet build YAMS-CLI`. + # License All code is licensed under the GNU Public License version 3. See the `LICENSE-CODE` file for full details. Art assets are licensed under [CC-BY-SA 4.0](https://creativecommons.org/licenses/by/4.0/). For the full list of authors and more details, please read the `Attribution.md` file located in [`YAMS-LIB/sprites/`](./YAMS-LIB/sprites/Attribution.md).