agb/README.md
2021-03-08 00:00:43 +00:00

28 lines
947 B
Markdown

# Rust for the Gameboy Advance
This is my in development library for rust on the gameboy advance. It uses
information from GbaTek, Tonc, and the existing
[rust-console/gba](https://github.com/rust-console/gba). Namely the gba.json
file comes from [rust-console/gba](https://github.com/rust-console/gba).
Note that this currently contains no documentation of any kind, unless you count
examples as documentation.
## Requirements
* Nightly rust, probably quite a recent version.
* Devkitarm.
* Cargo-xbuild is used too.
This is probably easiest to do in a container, the `start-dev.sh` script creates
and runs a development environment in a docker container.
## Makefile
The Makefile is written such that `make d-{example name}` runs the debug build
of the example, and `make r-{example name}` runs the release build.
## Stability
0% stable, I have no problems making drastic changes in the API in order to make
something nice to work with.