diff --git a/Readme.md b/Readme.md index 9309feb..4b974c3 100644 --- a/Readme.md +++ b/Readme.md @@ -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 `` 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.