Update README.md

This commit is contained in:
DanielMowitz 2019-08-29 14:34:29 +02:00 committed by GitHub
parent 9a24f423a4
commit 93f4513d3e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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.