From 1ce2c7cdc8ac0aaeb852b4fad16e170b3a149d4b Mon Sep 17 00:00:00 2001 From: Rachel Date: Fri, 8 Nov 2024 09:42:20 -0800 Subject: [PATCH] Add Troubleshooting FAQ in INSTALL.md; clarify match requirement in CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++---------- INSTALL.md | 25 ++++++++++++++----------- 2 files changed, 19 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82d1d24d67..005dd4b320 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,17 +24,12 @@ locally, a `check` target is included in the `Makefile`: make check ``` -If your pull request does not produce a matching ROM, then it will not be merged -without changes. +This target is run automatically as part of the default `make` command defined +in the provided `Makefile`. -## My Build is Failing After Merging from Main - -It is likely that your subprojects are out of date; update them with the following -command and re-build: - -```bash -meson subprojects update -``` +> [!IMPORTANT] +> If your pull request does not produce a matching ROM, then it will not be +> considered for merge until it has been updated to do so. ## Editor Enhancements diff --git a/INSTALL.md b/INSTALL.md index e4b1afb557..88f46ef8ec 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -260,12 +260,11 @@ A `Dockerfile` is provided with the repository should you choose to build the project as a container. If you do not have `docker` installed on your machine and wish to make use of this feature, follow the instructions [here](https://docs.docker.com/desktop/). -Once `docker` is installed, to setup the build environment, run: +Once `docker` is installed, to the build environment, run: ```bash make clean # only if you have an existing development environment docker build . -t pret/pokeplatinum -docker run -u $USER -w /rom -v .:/rom pret/pokeplatinum make configure ``` Then, run the following to build the ROM: @@ -326,15 +325,6 @@ Users of MacOS should replace `~/.bashrc` above with `~/.zshrc`. ## 4. Building the Repository -To set up the build system, run: - -```bash -make configure -``` - -This is only required once. If the process is successful, you will see a new -`build` folder in the repository folder. - To build the ROM, run: ```bash @@ -366,3 +356,16 @@ is insufficient. A fork of `binutils-gdb` which supports the overlay system employed by the console is available [here](https://github.com/joshua-smith-12/binutils-gdb-nds). For installation instructions, refer to [the `README.md`](https://github.com/joshua-smith-12/binutils-gdb-nds/blob/master/README.md). + +## Troubleshooting FAQ + +### My Build is Failing After Merging from Main + +It is likely that your subprojects are out of date; update them with the following +command: + +```bash +make update +``` + +And then try rebuilding.