An online Game Boy assembly programming tutorial
Switch branches/tags
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Add VSCode tasks file Apr 17, 2018
docs Use em dash Nov 30, 2018
src Rework introduction warnings Nov 11, 2018
README.md Flesh out README Jul 10, 2018
build.py Use env instead of hardcoded path Nov 30, 2018
structure.json Fix `&` into `&` Jul 20, 2018
template.html Use em dash Nov 30, 2018

README.md

gb-asm-tutorial

An online Game Boy assembly programming tutorial, hosted at https://eldred.fr/gb-asm-tutorial.

Building

The "output" is located in the docs folder, which is what is served publicly. (Note: GitHub Pages only considers the master branch's docs folder.)

The .html files in that folder's root are auto-generated (and thus shouldn't be edited manually). To re-generate them, run the build.py Python script. (May not work with Python 2).

The page's contents are located in the src folder. They are inserted into the template.html file, alongside a few other generated HTML snippets. The structure of the tutorial is contained within the structure.json file.

The structure

Each element MUST contain a leaf boolean attribute. If that attribute is true, then it is a leaf; otherwise it's not.

A leaf MUST contain the following attributes:

`id`
The page's ID; `.html` is appended to it to get the source and destination HTML page
`title`
The page's displayed name

A non-leaf MUST contain the following attributes:

`index`
The ID of the page that serves as the subtree/section's index
`subpages`
The list of subpages that this section contains. May contain non-leaves.
A non-leaf MAY contain the following attributes:
`special_pages`
A list of subpages that should not be present in the tree, but still be generated nonetheless.