backend-infra-engineer: Pre-0.2.2 2024 Q4 snapshot

README.md

@@ -1,12 +1,14 @@
 # Yet Another Zelda3 Editor
 
-- Platform: Windows, macOS, GNU/Linux
-- Dependencies: SDL2, ImGui
+- Platform: Windows, macOS, iOS, GNU/Linux
+- Dependencies: SDL2, ImGui, abseil-cpp
 
 ## Description
 
 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,27 @@ 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_emu**:   SNES Emulator
+- **yaze_py**:    Python Module
+- **yaze_test**:  Unit Tests
+- **z3ed**:       Command Line Interface
+
+Dependencies are included as submodules and will be built automatically. For those who want to reduce compile times, consider installing the dependencies on your system. See [build-instructions.md](docs/build-instructions.md) for more information.
+
 ## Documentation
 
 - For users, please refer to [getting_started.md](docs/getting-started.md) for instructions on how to use yaze.