From 8e63942ba4fb79cd05e1b76bf751813d78de62f9 Mon Sep 17 00:00:00 2001 From: scawful Date: Thu, 8 Aug 2024 18:46:33 -0400 Subject: [PATCH] update build instructions and other docs --- docs/build-instructions.md | 12 +++++++----- docs/getting-started.md | 2 +- docs/infrastructure.md | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/build-instructions.md b/docs/build-instructions.md index 384710e5..299d63b4 100644 --- a/docs/build-instructions.md +++ b/docs/build-instructions.md @@ -18,8 +18,9 @@ Install the following packages using `pacman -S ` - `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 ` - `cmake` -- `glew` - `sdl2` -- `boost-python3` +- `zlib` - `libpng` +- `abseil` +- `boost-python3` # iOS diff --git a/docs/getting-started.md b/docs/getting-started.md index 66b504a3..ac36cab3 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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". diff --git a/docs/infrastructure.md b/docs/infrastructure.md index bc61811f..7cf74ea6 100644 --- a/docs/infrastructure.md +++ b/docs/infrastructure.md @@ -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.