From 9e92097edf29fc894b544b4af87256e7187e65ba Mon Sep 17 00:00:00 2001 From: scawful Date: Fri, 20 Oct 2023 03:00:54 -0400 Subject: [PATCH] Update README --- README.md | 13 ++++++++----- docs/getting-started.md | 7 ++++--- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b0c941af..0fb112a0 100644 --- a/README.md +++ b/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 -------- ![image](https://user-images.githubusercontent.com/47263509/194669806-2b0da68d-9d38-4f52-bcce-c60ee861092c.png) - - diff --git a/docs/getting-started.md b/docs/getting-started.md index dab217c7..be311e78 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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! \ No newline at end of file