Update README
This commit is contained in:
13
README.md
13
README.md
@@ -15,15 +15,20 @@ Building and installation
|
||||
|
||||
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
|
||||
|
||||
cmake -S . -B build
|
||||
cmake -S . -B build
|
||||
|
||||
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
|
||||
--------
|
||||
@@ -34,5 +39,3 @@ SDL2, ImGUI and Abseil are subject to respective licenses.
|
||||
Screenshots
|
||||
--------
|
||||

|
||||
|
||||
|
||||
|
||||
@@ -7,8 +7,8 @@ Please note that this project is currently a work in progress, and some features
|
||||
## Prerequisites
|
||||
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)
|
||||
Basic knowledge of hexadecimal and binary data
|
||||
- A copy of "The Legend of Zelda: A Link to the Past" ROM file (US or JP)
|
||||
- Basic knowledge of hexadecimal and binary data
|
||||
|
||||
## Installation
|
||||
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:
|
||||
|
||||
Open the "ALTTP.sfc" ROM file 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.
|
||||
|
||||
|
||||
That's it! With these instructions, you should be able to get started with using YAZE. Happy editing!
|
||||
Reference in New Issue
Block a user