From 73d93d213ae19ccdb4a9f0036fa78ae5c19d9061 Mon Sep 17 00:00:00 2001 From: scawful Date: Fri, 20 Oct 2023 02:31:35 -0400 Subject: [PATCH] Add getting started doc for users --- docs/getting-started.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/getting-started.md diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 00000000..dab217c7 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,31 @@ +# Getting Started with YAZE + +This software allows you to modify the classic SNES game "The Legend of Zelda: A Link to the Past" by editing its ROM file. With this editor, you can change various aspects of the game, such as the maps, sprites, items, and more. + +Please note that this project is currently a work in progress, and some features may not be fully implemented or may be subject to change. + +## 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 + +## Installation +To install YAZE, follow these steps based on your platform: + +### Windows + +### MacOS + +### GNU/Linux + +## Usage +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