mirror of
https://github.com/SMGCommunity/Petari.git
synced 2024-11-24 14:09:51 +00:00
Link Section, Build -> Build.md, Formatting
This commit is contained in:
parent
6db3793eb3
commit
f0c17e978c
23
README.md
23
README.md
@ -1,15 +1,20 @@
|
||||
# Super Mario Galaxy 1 Decompilation
|
||||
|
||||
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/shibbo/Petari/master/data/percent.json&style=flat" />
|
||||
# Petari ![Badge Decompiled]
|
||||
*A **Super Mario Galaxy 1 US** Decompilation Project*
|
||||
|
||||
This repo contains a WIP decompilation of Super Mario Galaxy 1 (USA).
|
||||
---
|
||||
|
||||
## Build Instructions
|
||||
**[❮ Build ❯][Build]**
|
||||
**[❮ Contribute ❯][Contribute]**
|
||||
|
||||
1. Obtain a clean copy of a main.dol from Super Mario Galaxy 1 and rename it to `baserom.dol`, and place it on the root.
|
||||
2. Run `setup.py` to download and install all of the dependencies.
|
||||
3. Run `build.py`, then use `check.py` to verify matching status. For more information, see docs/Contributing.
|
||||
---
|
||||
|
||||
## Contributions
|
||||
|
||||
Want to contribute, or learn how to contribute? Try looking into docs/Contributing! We will be glad to answer any questions for people who wish to contribute. All pull requests and issues are welcome.
|
||||
|
||||
|
||||
<!----------------------------------------------------------------------------->
|
||||
|
||||
[Build]: docs/Build.md
|
||||
[Contribute]: docs/CONTRIBUTING.md
|
||||
|
||||
[Badge Decompiled]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/shibbo/Petari/master/data/percent.json&style=flat
|
5
docs/Build.md
Normal file
5
docs/Build.md
Normal file
@ -0,0 +1,5 @@
|
||||
## Build Instructions
|
||||
|
||||
1. Obtain a clean copy of a main.dol from Super Mario Galaxy 1 and rename it to `baserom.dol`, and place it on the root.
|
||||
2. Run `setup.py` to download and install all of the dependencies.
|
||||
3. Run `build.py`, then use `check.py` to verify matching status. For more information, see docs/Contributing.
|
@ -1,5 +1,8 @@
|
||||
# Contributing
|
||||
|
||||
We will be glad to answer any questions for people who wish to contribute.
|
||||
All pull requests and issues are welcome.
|
||||
|
||||
To contribute, you will need the following tools:
|
||||
|
||||
* A disassembler, IDA Pro or Ghidra work very well (you can also use a decompiler, it can make some things easier)
|
||||
|
Loading…
Reference in New Issue
Block a user