update build instructions and other docs

This commit is contained in:
scawful
2024-08-08 18:46:33 -04:00
parent 478230e543
commit 8e63942ba4
3 changed files with 9 additions and 7 deletions

View File

@@ -18,8 +18,9 @@ Install the following packages using `pacman -S <package-name>`
- `mingw-w64-x86_64-gcc`
- `mingw-w64-x86_64-gcc-libs`
- `mingw-w64-x86_64-cmake`
- `mingw-w64-x86_64-glew`
- `mingw-w64-x86_64-lib-png`
- `mingw-w64-x86_64-sdl2`
- `mingw-w64-x86_64-libpng`
- `mingw-w64-x86_64-abseil-cpp`
For `yaze_py` you will need Boost Python
@@ -27,15 +28,16 @@ For `yaze_py` you will need Boost Python
# macOS
Prefer to use clang over gcc.
Prefer to use clang provided with XCode command line tools over gcc.
Install the following packages using `brew install <package-name>`
- `cmake`
- `glew`
- `sdl2`
- `boost-python3`
- `zlib`
- `libpng`
- `abseil`
- `boost-python3`
# iOS

View File

@@ -1,4 +1,4 @@
# Getting Started with YAZE
# Getting Started
This software allows you to modify "The Legend of Zelda: A Link to the Past".

View File

@@ -41,7 +41,7 @@ For developers to reference.
- **lib**: Contains the dependencies as git submodules
- **test**: Contains testing interface `yaze_test`
### Flow of Control
## Flow of Control
- [app/yaze.cc](../src/app/yaze.cc)
- Initializes `absl::FailureSignalHandler` for stack tracing.