Game-Decompilation/mzm
1
0
Fork 0
mirror of https://github.com/YohannDR/mzm.git synced 2024-10-06 18:13:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update markdown files (#18)

Browse Source 
- Makes README a bit more noob friendly
- Minor formatting/typo fixes
This commit is contained in:
biosp4rk 2024-07-12 08:33:03 -07:00 committed by GitHub
parent 9d5361230d
commit 273c7b352d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/pull_request_template.md vendored
View File

@ -1 +1 @@
- [ ] I have read and understood the contitions outlined in [CONTRIBUTING.md](CONTRIBUTING.md)
- [ ] I have read and understood the conditions outlined in [CONTRIBUTING.md](CONTRIBUTING.md)

18
CONTRIBUTING.md
View File

@ -1,11 +1,11 @@
# Important
Anyone wanting to contribute *MUST* read the following and adhere to the steps
outlined, in order to not violate any Copyright.
outlined, in order to not violate any copyright.
This decompile is a [clean room design](https://en.wikipedia.org/wiki/Clean_room_design).
It *MUST* not incorperate any code owned by Nintendo or other third parties.
In Order to achieve this all code has to be written completely fresh, without
In order to achieve this, all code has to be written completely fresh, without
reference to any third party code, no matter if leaked or not.
Derived from this there is the following requirement for contributors:
@ -23,10 +23,10 @@ $ make check
Then these are the rough steps to decompile a function:
1. pick a function to decompile (from `asm/disasm_*.s`)
2. create a new file in `src/` if necessary (also adjust `linker.ld`)
3. go through it, roughly line by line, and translate it into C (into the proper file in `src/`)
4. compile it, see what doesn't match, and change it
5. repeat step 4. until everything matches (`make diff` can be helpful, as well as https://cexplore.karathan.at/ and https://decomp.me/)
6. make sure everything still works (`make check` should give you OK)
7. open a PR on github
1. Pick a function to decompile (from `asm/disasm_*.s`)
2. Create a new file in `src/` if necessary (also adjust `linker.ld`)
3. Go through it, roughly line by line, and translate it into C (into the proper file in `src/`)
4. Compile it, see what doesn't match, and change it
5. Repeat step 4 until everything matches (`make diff` can be helpful, as well as https://cexplore.karathan.at/ and https://decomp.me/)
6. Make sure everything still works (`make check` should give you OK)
7. Open a PR on github

4
README.md
View File

@ -29,7 +29,7 @@ This produces the following ROMs:
- **WINDOWS ONLY** : Install and setup [WSL](https://docs.microsoft.com/en-us/windows/wsl/install)
- Install the dependencies (an `apt update` might be necessary for binutils)
- Build agbcc (run `./build.sh`)
- Add agbcc to your path (export PATH="agbcc path:$PATH")
- Add agbcc to your path (`export PATH="<agbcc_path>:$PATH"`, where `<agbcc_path>` is the full path to the agbcc directory)
- Build preproc (run `make` in tools/preproc)
## Build
@ -38,5 +38,5 @@ This produces the following ROMs:
- Run the data extractor if necessary:
* Compile: `cd tools && . compile_c_extractor.sh && cd ..`
* Run: `tools/c_extractor`
* If the C version doesn't work, run the C# version `tools/extractor`
* If the C version doesn't work, run the C# version `tools/extractor` (may require `chmod +x tools/extractor` first)
- Run `make` (using the -j option is recommended to speed up the process)