Skip to content

Commit

Permalink
Add compilation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
Miepee committed Oct 20, 2023
1 parent 6574095 commit 803987c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 803987c

Please sign in to comment.