scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
scawful
2023-10-20 03:00:54 -04:00
parent 32d20d3a04
commit 9e92097edf
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -15,15 +15,20 @@ Building and installation
1. Clone the repository 1. Clone the repository
git clone --recurse-submodules https://github.com/scawful/yaze.git git clone --recurse-submodules https://github.com/scawful/yaze.git
2. Create the build directory and configuration 2. Create the build directory and configuration
cmake -S . -B build cmake -S . -B build
3. Build and run. 3. Build and run.
cmake --build build cmake --build build
## Documentation
- For users, please refer to [getting_started.md](docs/getting_started.md) for instructions on how to use YAZE.
- For developers, please refer to [infrastructure.md](docs/infrastructure.md) for information on the project's infrastructure.
License License
-------- --------
@@ -34,5 +39,3 @@ SDL2, ImGUI and Abseil are subject to respective licenses.
Screenshots Screenshots
-------- --------
![image](https://user-images.githubusercontent.com/47263509/194669806-2b0da68d-9d38-4f52-bcce-c60ee861092c.png) ![image](https://user-images.githubusercontent.com/47263509/194669806-2b0da68d-9d38-4f52-bcce-c60ee861092c.png)

7
docs/getting-started.md
View File

@@ -7,8 +7,8 @@ Please note that this project is currently a work in progress, and some features
## Prerequisites ## Prerequisites
Before you start using YAZE, make sure you have the following: Before you start using YAZE, make sure you have the following:
A copy of "The Legend of Zelda: A Link to the Past" ROM file (US or JP) - A copy of "The Legend of Zelda: A Link to the Past" ROM file (US or JP)
Basic knowledge of hexadecimal and binary data - Basic knowledge of hexadecimal and binary data
## Installation ## Installation
To install YAZE, follow these steps based on your platform: To install YAZE, follow these steps based on your platform:
@@ -23,9 +23,10 @@ To install YAZE, follow these steps based on your platform:
To use the Link to the Past ROM Editor, follow these steps: To use the Link to the Past ROM Editor, follow these steps:
Open the "ALTTP.sfc" ROM file using the "File" menu. Open the "ALTTP.sfc" ROM file using the "File" menu.
... ...
Save your changes using the "File" menu. Save your changes using the "File" menu.
Backup files are enabled by default. Each save will produce a timestamped copy of your ROM before you last saved. Backup files are enabled by default. Each save will produce a timestamped copy of your ROM before you last saved.
That's it! With these instructions, you should be able to get started with using YAZE. Happy editing! That's it! With these instructions, you should be able to get started with using YAZE. Happy editing!