sms/gctGenerator
1
0
Fork 0
Code Issues Pull requests Activity

update readme

Browse source
This commit is contained in:
Matteias Collet 2020-07-10 04:29:22 +02:00
parent 32542db6f7
commit 982dd564d2
1 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Readme.md
View file

@ -19,11 +19,7 @@ This repository contains the code behind the Super Mario Sunshine Cheatfile Gene
### Updating Practice Codes
The codes are stored as XML files (one for each game version) in the [/codes](https://github.com/BitPatty/gctGenerator/tree/master/codes) directory. If you want to add or change codes edit the corresponding XML file. Note that GMSJ0A refers to the NTSC-J 1.1 release of Super Mario Sunshine. (It's not actually called version A but that's what we've been calling it for years due to a misconception on what the A on the back of the box means).
#### Code Removal
Codes are generally not deleted. If you want to remove a code, please comment it out in the corresponding XML file.
The codes are stored in the `Codes.xml` file. If you want to add or change codes edit the XML file. Note that GMSJ0A refers to the NTSC-J 1.1 release of Super Mario Sunshine. (It's not actually called version A but that's what we've been calling it for years due to a misconception on what the A on the back of the box means).
### Updating Guides
@ -31,6 +27,8 @@ You can find the guides in the [site](https://github.com/BitPatty/gctGenerator/t
Note that in the code reference files everything following the `<!-- injectionpoint -->` tag will be removed during the next build.
Before opening a PR make sure you run `yarn codes:clean` to remove the injected codes.
### Site Development
If you intend to change site code you need [NodeJS](https://nodejs.org/en/) version 12.18.1 or greater installed on your local.