max
/
bitsy-parser
1
0
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

update readme

This commit is contained in:
Max Bradbury 2020-04-13 19:28:22 +01:00
parent 2ee08dd264
commit 799a97c4dd
2 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.toml
View File

@ -1,6 +1,6 @@
[package]
name = "bitsy-parser"
version = "0.65.4"
version = "0.65.5"
authors = ["Max Bradbury <max@tinybird.info>"]
edition = "2018"
description = "A parser for Bitsy game data"

7
README.md
View File

@ -6,7 +6,8 @@ the version number follows Bitsy itself, so version 0.65.* targets Bitsy 6.5.
## how to use
this sample program converts the player avatar to a smiley face.
a simple example program:
```rust
extern crate bitsy_parser;
use std::{env, fs};
@ -51,10 +52,6 @@ some more practical uses would be things like:
## todo
### failing tests
test_room_from_string shows an unexpected ordering for the items in the output of room::to_string
### tidy up
* refactor the more shonky bits to idiomatic rust