Setting up

Downloading

There are a couple of options for using this repository.

• Using GitHub's “template” functionality: You can simply create a new repo with this one as a template. Just follow that link! (Or click the green button at the top-right of the “Code” page.)
• Cloning: This is especially useful if you want to host your project on other platforms, such as Codeberg or SourceHut. It requires a little caution, since this repository uses submodules.
  1. Clone the repo as usual, passing the --recursive flag (e.g. git clone https://github.com/ISSOtm/gb-starter-kit --recursive).
  2. If you forgot to pass --recursive to git clone, you can run git submodule update --init at any time from within the repo.
• Do not use GitHub's “download ZIP” functionality—it will leave the src/include/hardware.inc and src/include/rgbds-structs directories empty (unless you feel like filling them in manually).

Setting up

You will need:

• RGBDS, at least version 0.9.0;
• Python 3;
• GNU Make, at least version 4.0(?)

And now, you're ready check out how to use the project!