diff --git a/README.md b/README.md index 5a7fe803..7dde2535 100644 --- a/README.md +++ b/README.md @@ -15,26 +15,32 @@ Building and installation 1. Clone the repository +``` git clone --recurse-submodules https://github.com/scawful/yaze.git +``` 2. Create the build directory and configuration +``` cmake -S . -B build +``` 3. Build and run. +``` cmake --build build +``` ## Documentation -- For users, please refer to [getting_started.md](docs/getting-started.md) for instructions on how to use YAZE. +- For users, please refer to [getting_started.md](docs/getting-started.md) for instructions on how to use yaze. - For developers, please refer to [infrastructure.md](docs/infrastructure.md) for information on the project's infrastructure. License -------- YAZE is distributed under the [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt) license. -SDL2, ImGUI and Abseil are subject to respective licenses. +SDL2, ImGui and Abseil are subject to respective licenses. Screenshots --------