Update README.md
This commit is contained in:
32
README.md
32
README.md
@@ -1,3 +1,33 @@
|
||||
# Yet Another Zelda3 Editor
|
||||
|
||||
Soon.
|
||||
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 "<MinGW Makefiles/Unix Makefiles>" ../
|
||||
|
||||
5. Build and run.
|
||||
|
||||
make yaze
|
||||
cmake --build <yaze_root/build> --config Debug --target yaze
|
||||
|
||||
Screenshots
|
||||
--------
|
||||

|
||||
|
||||
|
||||
Reference in New Issue
Block a user