agb/README.md

35 lines
1 KiB
Markdown
Raw Normal View History

2021-04-16 09:58:57 +10:00
# Rust for the Game Boy Advance
2021-03-07 04:58:59 +11:00
2021-04-16 09:58:57 +10:00
This is my in development library for rust on the Game Boy Advance. It uses
2021-03-07 04:58:59 +11:00
information from GbaTek, Tonc, and the existing
2021-04-11 03:32:47 +10:00
[rust-console/gba](https://github.com/rust-console/gba).
2021-03-07 04:58:59 +11:00
Note that this currently contains no documentation of any kind, unless you count
examples as documentation.
## Build Requirements
2021-03-07 04:58:59 +11:00
* Nightly rust, probably quite a recent version.
2021-04-11 03:32:47 +10:00
* arm eabi binutils
* Debian and derivatives: `sudo apt install binutils-arm-none-eabi`
* Arch Linux and derivatives: `pacman -S arm-none-eabi-binutils`
2021-03-07 04:58:59 +11:00
## Test Requirements
* mgba 0.9.0
* mgba-test-runner
* Run `cargo install --path mgba-test-runner` inside this directory
## Real Hardware Build
* Need gbafix, rust implementation can be installed with `cargo install gbafix`.
* On compiled elf file, additionally need to
```bash
arm-none-eabi-objcopy -O binary {input-elf} {output-gba}
gbafix {output-gba}
```
2021-03-08 11:00:43 +11:00
## Stability
0% stable, I have no problems making drastic changes in the API in order to make
something nice to work with.