Update README.md
This commit is contained in:
parent
9a24f423a4
commit
93f4513d3e
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -1,3 +1,15 @@
|
||||||
# Rust-Sdl-Framework
|
# Rust-Sdl-Framework
|
||||||
|
|
||||||
SDL2-based 2d game framework written in Rust
|
An SDL2-based 2D-game framework based on unsigned 4-bit integers written in Rust. An example binary can be found under /src/bin.rs
|
||||||
|
|
||||||
|
## Colors
|
||||||
|
|
||||||
|
15 of the 16 possible values of the u4 ints are set by a color space table given to the renderer. The 16th value is always full alpha.
|
||||||
|
|
||||||
|
## Docs
|
||||||
|
|
||||||
|
You can build the documentation by running running `cargo rustdoc`
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
It is advisable to run the tests in the following manner: `cargo test -- --test-threads 1` as the tests otherwise block the SDL environment for each other.
|
||||||
|
|
Loading…
Reference in a new issue