From ae3664fc08a3fbbd3a953d9df92b19014e1482f7 Mon Sep 17 00:00:00 2001 From: Justin Scofield <47263509+scawful@users.noreply.github.com> Date: Thu, 23 Jun 2022 16:33:07 -0400 Subject: [PATCH] Update README.md --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f6ef14f..9a6e0023 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # Yet Another Zelda3 Editor -Soon. \ No newline at end of file + Platform: Windows, macOS, GNU/Linux + Dependencies: SDL2, ImGui + +## Description +General purpose editor for The Legend of Zelda: A Link to the Past for the Super Nintendo. + +Building and installation +------------------------- +[CMake](http://www.cmake.org "CMake") is required to build Premia + +1. Clone the repository + + git clone --recurse-submodules https://github.com/scawful/yaze.git + +3. Create a build directory in the root workspace folder + + mkdir build + +4. Move to the build directory and generate the build files specified in CMakeLists.txt + + cmake -G "" ../ + +5. Build and run. + + make yaze + cmake --build --config Debug --target yaze + +Screenshots +-------- +![image](https://user-images.githubusercontent.com/47263509/175393817-39ba86c1-d940-4426-b4db-e2c0f6bd857f.png) +