update readme

This commit is contained in:
scawful
2024-08-08 00:54:22 -04:00
parent 2d271eeb48
commit 87227a6efe

View File

@@ -7,6 +7,8 @@
General purpose editor for The Legend of Zelda: A Link to the Past for the Super Nintendo.
Provides bindings in C and Python for building custom tools and utilities.
Takes heavy inspiration from ALTTP community efforts such as [Hyrule Magic](https://www.romhacking.net/utilities/200/) and [ZScream](https://github.com/Zarby89/ZScreamDungeon)
Building and installation
@@ -14,23 +16,26 @@ Building and installation
[CMake](http://www.cmake.org "CMake") is required to build yaze
1. Clone the repository
2. Create the build directory and configuration
3. Build and run the application
4. (Optional) Run the tests
```
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
```
By default this will build all targets.
- **yaze**: Editor Application
- **yaze_c**: C Library
- **yaze_py**: Python Module
- **yaze_test**: Unit Tests
- **z3ed**: Command Line Interface
Dependencies are included as submodules and will be built automatically.
## Documentation
- For users, please refer to [getting_started.md](docs/getting-started.md) for instructions on how to use yaze.