diff options
| -rw-r--r-- | INSTALL.md | 5 | ||||
| -rw-r--r-- | README.md | 11 |
2 files changed, 16 insertions, 0 deletions
@@ -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. + diff --git a/README.md b/README.md new file mode 100644 index 00000000..73b98c8b --- /dev/null +++ b/README.md @@ -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. |