diff options
| author | Aetias <aetias@outlook.com> | 2023-09-18 18:18:29 +0200 |
|---|---|---|
| committer | Aetias <aetias@outlook.com> | 2023-09-18 18:18:29 +0200 |
| commit | f91cb67e50df4bb8add2cd608f5a75090bc0504e (patch) | |
| tree | c5f81091994fb6246ab07ca635404fc68dfb74c4 /README.md | |
| parent | 478e788165d80b09cb8ae50f5a39b7ed6fd8d089 (diff) | |
Update README and INSTALL
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
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. |