Leahnaya/pokeplatinum
1
0
Fork 0
mirror of https://github.com/pret/pokeplatinum.git synced 2026-09-28 20:39:22 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add Troubleshooting FAQ in INSTALL.md; clarify match requirement in CONTRIBUTING.md

Browse Source
This commit is contained in:
Rachel
2024-11-08 09:42:20 -08:00
parent 3992b4c139
commit 1ce2c7cdc8
2 changed files with 19 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@@ -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

25
INSTALL.md
View File

@@ -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.