gba/README.md
Neil P 5114f89448
Simplify build process (#106)
* Simplify build process

- Remove dependencies on DevkitPro
- Use linker similarly to min-gba
- Update cargo.toml so that dev builds will build
- Update cargo config so that std builds can run without the linker for
  testing purposes
- Update CI flow to remove xbuild dependency

* Add windows toolchain install

* Add windows section to toolchain install instructions
2021-02-20 11:49:40 -07:00

2.3 KiB

License:Apache2 ci crates.io docs.rs

  • Built with cargo-make
  • Stability:None

gba

Eventually there will be a full Tutorial Book that goes along with this crate. However, currently the development focus is leaning towards having minimal coverage of all the parts of the GBA. Until that's done, unfortunately the book will be in a rather messy state.

What's Missing

The following major GBA features are still missing from the crate:

  • Affine Graphics
  • Interrupt Handling
  • Serial Communication

Build Dependencies

Install required cargo packages

rustup install nightly
rustup +nightly component add rust-src
cargo install cargo-make
cargo install gbafix

Install arm build tools

  • Ubuntu
    sudo apt-get install binutils-arm-none-eabi
    
  • OSX
    brew install --cask gcc-arm-embedded
    
  • Windows
    • Download the GNU Arm Embedded Toolchain
    • Install the toolchain, make sure to select "Add path to environment variable" during install

First Time Setup

Writing a Rust program for the GBA requires a fair amount of special setup. All of the steps are detailed for you in the Development Setup part at the start of the book.

If you've done the described global setup once before and just want to get a new project started quickly we got you covered:

curl https://raw.githubusercontent.com/rust-console/gba/master/init.sh -sSf | bash -s APP_NAME

Contribution

This crate is Apache2 licensed and any contributions you submit must also be Apache2 licensed.