gba/README.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

[![License:Apache2](https://img.shields.io/badge/License-Apache2-green.svg)](https://www.apache.org/licenses/LICENSE-2.0)
2018-11-15 13:48:45 +11:00
[![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/)
2018-11-19 07:09:23 +11:00
* [![Built with cargo-make](https://sagiegurari.github.io/cargo-make/assets/badges/cargo-make.svg)](https://sagiegurari.github.io/cargo-make)
2018-11-21 17:44:58 +11:00
* ![Stability:None](https://img.shields.io/badge/Stability-None-red.svg)
2018-11-19 07:09:23 +11:00
# 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.
2018-11-21 17:44:58 +11:00
If you've done the global setup once before and just want to get a new project
started quickly we got you covered:
2018-11-19 02:25:32 +11:00
```sh
curl https://raw.githubusercontent.com/rust-console/gba/master/init.sh -sSf | bash -s APP_NAME
2018-11-19 02:25:32 +11:00
```
# Contribution
This crate is Apache2 licensed and any contributions you submit must also be
Apache2 licensed.