update readme

This commit is contained in:
Corwin Kuiper 2021-06-03 18:55:42 +01:00
parent 9adbfbe275
commit a764c8c636

View file

@ -1,11 +1,15 @@
# Rust for the Game Boy Advance # Rust for the Game Boy Advance
This is my in development library for rust on the Game Boy Advance. It uses This is a library for making games on the Game Boy Advance using the Rust
information from GbaTek, Tonc, and the existing programming language. It attempts to be a high level abstraction over the
[rust-console/gba](https://github.com/rust-console/gba). internal workings of the Game Boy Advance whilst still being high performance
and memory efficient.
The documentation for the latest release can be found on
[docs.rs](https://docs.rs/agb/latest/agb/). Note that this repository does not
nesesarily contain the latest release, but in development versions. Futher work
is needed to improve the documentation.
Note that this currently contains no documentation of any kind, unless you count
examples as documentation.
## Build Requirements ## Build Requirements