gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2026-08-20 13:54:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Describe how to patch external projects

Browse Source
This commit is contained in:
Rangi
2026-07-02 12:37:26 -04:00
parent 4a77c42ed7
commit 9b4df11473
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CONTRIBUTING.md
+7 -2
View File
@@ -225,16 +225,21 @@ Each one is a binary RNG file which is passed to the `rgbgfx_test` program.
### External projects
Each `*.cfg` file corresponds to one test.
Each `.cfg` file corresponds to one test.
Each one defines the parameters for a real external project that builds using RGBDS.
1. Make sure the downstream project supports
<code>make <var>&lt;target&gt;</var> RGBDS=<var>&lt;path/to/RGBDS/&gt;</var></code>.
<code>make <var>&lt;target&gt;</var> RGBDS=<var>&lt;path/to/rgbds/&gt;</var></code>.
While the test suite supports any Make target name, only
[Make](//gnu.org/software/make) is currently supported, and the Makefile must
support a `RGBDS` variable to use a non-system RGBDS directory.
2. Create the new `.cfg` file, following the existing ones.
If an external project does not support `make RGBDS=`, or otherwise fails to
build with current RGBDS, then then you can edit the project to build correctly,
and create a patch with `git diff` to be committed as
<code>test/external/patches/<var>&lt;project&gt;</var>.patch</code>.
## Container images
The CI will