mirror of
https://github.com/italicsjenga/gba.git
synced 2024-12-24 03:11:29 +11:00
5114f89448
* 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
66 lines
2.3 KiB
Markdown
66 lines
2.3 KiB
Markdown
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
[](https://github.com/rust-console/gba/actions?query=workflow%3Aci)
|
|
[](https://crates.io/crates/gba)
|
|
[](https://docs.rs/gba/latest/gba/)
|
|
|
|
* [](https://sagiegurari.github.io/cargo-make)
|
|
* 
|
|
|
|
# gba
|
|
|
|
_Eventually_ there will be a full [Tutorial
|
|
Book](https://rust-console.github.io/gba/) 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
|
|
```sh
|
|
rustup install nightly
|
|
rustup +nightly component add rust-src
|
|
cargo install cargo-make
|
|
cargo install gbafix
|
|
```
|
|
|
|
Install arm build tools
|
|
* Ubuntu
|
|
```shell
|
|
sudo apt-get install binutils-arm-none-eabi
|
|
```
|
|
* OSX
|
|
```shell
|
|
brew install --cask gcc-arm-embedded
|
|
```
|
|
* Windows
|
|
* Download the [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
|
|
* 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](https://rust-console.github.io/gba/development-setup.html) 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:
|
|
|
|
```sh
|
|
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.
|