add more details to the readme

This commit is contained in:
Corwin Kuiper 2021-03-08 00:00:43 +00:00
parent 65b77e0b3a
commit 195004e8b2

View file

@ -12,10 +12,17 @@ examples as documentation.
* Nightly rust, probably quite a recent version.
* Devkitarm.
* Cargo-xbuild is used too.
This is probably easiest to do in a container.
This is probably easiest to do in a container, the `start-dev.sh` script creates
and runs a development environment in a docker container.
## Makefile
The Makefile is written such that `make d-{example name}` runs the debug build
of the example, and `make r-{example name}` runs the release build.
## Stability
0% stable, I have no problems making drastic changes in the API in order to make
something nice to work with.