Update README and INSTALL

This commit is contained in:
Aetias
2023-09-18 18:18:29 +02:00
parent 478e788165
commit f91cb67e50
2 changed files with 16 additions and 0 deletions
+5
View File
@@ -3,6 +3,7 @@
Contents:
- [Prerequisites](#prerequisites)
- [Build the ROM](#build-the-rom)
## Prerequisites
@@ -16,3 +17,7 @@ python -m pip install -r tools/requirements.txt
python tools/setup.py
```
## Build the ROM
To build the ROM, simply run `make` in the root directory.
+11
View File
@@ -0,0 +1,11 @@
# The Legend of Zelda: Phantom Hourglass
**Work in progress!** This project aims to recreate source code for ***The Legend of Zelda: Phantom Hourglass*** by decompiling
assembly code by hand. **The repository only contains code.** To build the ROM, you must own an existing copy of the game to
extract assets from.
**Note:** The project can not build a ROM yet. Furthermore, it only targets the European version, and other versions will
be supported later.
## How to install
See [INSTALL.md](INSTALL.md) for instructions on how to install the project.