scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
scawful
2023-10-20 03:00:54 -04:00
parent 32d20d3a04
commit 9e92097edf
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -15,15 +15,20 @@ Building and installation
1. Clone the repository
git clone --recurse-submodules https://github.com/scawful/yaze.git
git clone --recurse-submodules https://github.com/scawful/yaze.git
2. Create the build directory and configuration
cmake -S . -B build
cmake -S . -B build
3. Build and run.
cmake --build build
cmake --build build
## Documentation
- 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
--------
@@ -34,5 +39,3 @@ SDL2, ImGUI and Abseil are subject to respective licenses.
Screenshots
--------
![image](https://user-images.githubusercontent.com/47263509/194669806-2b0da68d-9d38-4f52-bcce-c60ee861092c.png)