From 9d4f4964623b57fcb6600bc9edfb391b48483743 Mon Sep 17 00:00:00 2001 From: Matteias Collet Date: Wed, 1 Jul 2020 08:38:26 +0200 Subject: [PATCH] update readme --- Readme.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index 4dd0bfb..68b23f2 100644 --- a/Readme.md +++ b/Readme.md @@ -19,12 +19,14 @@ 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 [site/.vuepress/public/codes](https://github.com/BitPatty/gctGenerator/tree/master/site/.vuepress/public/codes) directory. If you want to add or change codes edit the corresponding XML file. Node 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). +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. Node 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 You can find the guides in the [site](https://github.com/BitPatty/gctGenerator/tree/master/site) folder. Simply edit the corresponding markdown file (.md). +Note that in the code reference files everything following the `` tag will be removed during the next build. + ### 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. @@ -44,6 +46,13 @@ yarn dev yarn build ``` +The XML codes will be written automatically to the json file and code reference during the following actions: + +- Starting the development server with `yarn dev` +- Building the site with `yarn build` + +If you want to inject the codes at any given point you can use `yarn codes:ineject`. + ### Build and preview the site (Docker) The project root provides a [docker-compose](https://docs.docker.com/compose/) file, which creates a clean build (with the same configuration as the production build) and spins up a minimal Apache server on your local, serving the resulting build on port 8080.