gba/README.md
Shadlock0133 4145517b8f
Change GBA to GameBoy Advance in README
I saw somebody on twitter saying they couldn't figure out what GBA stands for.
Given that full name isn't currently used anywhere, this change could help people not familiar video games abbreviations.
2018-12-14 11:03:03 +01:00

31 lines
1.2 KiB
Markdown

[![License:Apache2](https://img.shields.io/badge/License-Apache2-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)
[![travis.ci](https://travis-ci.org/rust-console/gba.svg?branch=master)](https://travis-ci.org/rust-console/gba)
[![crates.io](https://img.shields.io/crates/v/gba.svg)](https://crates.io/crates/gba)
[![docs.rs](https://docs.rs/gba/badge.svg)](https://docs.rs/gba/latest/gba/)
* [![Built with cargo-make](https://sagiegurari.github.io/cargo-make/assets/badges/cargo-make.svg)](https://sagiegurari.github.io/cargo-make)
* ![Stability:None](https://img.shields.io/badge/Stability-None-red.svg)
# gba
A crate that helps you make GameBoy Advance (GBA) games
# First Time Setup
This crate requires a fair amount of special setup. All of the steps are
detailed for you [in the 0th chapter of the
book](https://rust-console.github.io/gba/00-introduction/03-development-setup.html) that goes with this
crate.
If you've done the 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.