agb/README.md

28 lines
947 B
Markdown
Raw Normal View History

2021-03-07 04:58:59 +11:00
# 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.
2021-03-08 11:00:43 +11:00
* Cargo-xbuild is used too.
2021-03-07 04:58:59 +11:00
2021-03-08 11:00:43 +11:00
This is probably easiest to do in a container, the `start-dev.sh` script creates
and runs a development environment in a docker container.
2021-03-07 05:04:22 +11:00
## Makefile
The Makefile is written such that `make d-{example name}` runs the debug build
2021-03-08 11:00:43 +11:00
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.