Game-Decompilation/Petari
1
0
Fork 0
mirror of https://github.com/SMGCommunity/Petari.git synced 2024-11-24 05:59:43 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

re-add README after accidental deletion.

Browse Source
This commit is contained in:
shibbo 2020-05-13 01:17:54 -04:00
parent cdc0ced6ae
commit e9b092cc8e
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md Normal file
View File

@ -0,0 +1,16 @@
# Petari
A decompilation of Super Mario Galaxy 1. The end goal is to be as close to 1:1 to the original code as possible.
# Compiling
Ensure you have CodeWarrior in your $PATH enviornment. You also need to have your own copy of the Nintendo Wii SDK (this will NOT be provided!) and ensure the two paths in sources.txt is accurate. After you have those configured, just run the python script:
```
python build.py
```
If you do not have CodeWarrior in $PATH, stick the executables into a folder on the root named "tools".
If it successfully builds, all of the binaries are located in the "build" folder.
# Contributing
All contributions are welcome, just as long as they follow the current coding style. Look at any source file to see the general style. Also, before contributing, be sure that the code matches 1:1 COMPLETELY to the original game.