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
2024-08-08 00:54:22 -04:00
parent 2d271eeb48
commit 87227a6efe
1 changed files with 15 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -7,6 +7,8 @@
General purpose editor for The Legend of Zelda: A Link to the Past for the Super Nintendo. 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) 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 Building and installation
@@ -14,23 +16,26 @@ Building and installation
[CMake](http://www.cmake.org "CMake") is required to build yaze [CMake](http://www.cmake.org "CMake") is required to build yaze
1. Clone the repository 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 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
``` ```
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 ## 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.