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

Update README.md

Browse Source
This commit is contained in:
Justin Scofield
2023-10-20 03:06:39 -04:00
committed by GitHub
parent 6c206b1082
commit e08e782f9c
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -15,26 +15,32 @@ Building and installation
1. Clone the repository 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 2. Create the build directory and configuration
```
cmake -S . -B build cmake -S . -B build
```
3. Build and run. 3. Build and run.
```
cmake --build build cmake --build build
```
## Documentation ## 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. - For developers, please refer to [infrastructure.md](docs/infrastructure.md) for information on the project's infrastructure.
License License
-------- --------
YAZE is distributed under the [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt) 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 Screenshots
-------- --------