refactor readme

This commit is contained in:
Prakxo
2023-09-27 22:41:27 +02:00
parent c845e2916e
commit 37f0501049
+6 -3
View File
@@ -1,14 +1,18 @@
# Animal Crossing Decompilation
# Animal Crossing Decompilation [![Discord Channel][discord-badge]][discord]
[discord]: https://discord.zelda64.dev
[discord-badge]: https://img.shields.io/discord/727908905392275526?color=%237289DA&logo=discord&logoColor=%23FFFFFF
Decompilation in progress of Animal Crossing (GAFE01)
An N64 version of the game is being worked on [here](https://github.com/zeldaret/af)
## Cloning
Use `--recursive` when cloning to have ppcdis in the repository.
## Build
**Currently, it has only been tested with [wibo](https://github.com/decompals/wibo) under WSL2, but should build under other platforms and with Wine.**
**It's preferible to use [wibo](https://github.com/decompals/wibo), a lightweight
Wine replacement to work with the compilers, but Wine is still usable**
### Building
@@ -21,7 +25,6 @@ Use `--recursive` when cloning to have ppcdis in the repository.
- Headers should be at `$N64_SDK/ultra/usr/include`.
- You may need to modify `Gpopmtx`'s `param` member to be `unsigned int`.
- Install DevkitPPC, Ninja and Python:
- **Only tested with DevkitPPC r41 and Python 3.8.10**, however other versions should work fine.
- Install Python modules from requirements.txt (`pip install -r requirements.txt`)
- Run configure.py
- Run ninja