Initial commit.

1 files changed, 29 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..726a6e2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+This is a light Rust wrapper around the WildMIDI software synthesizer library.
+
+
+# Examples
+
+Included in this repository is a binary project exposing a very basic MIDI
+player - essentially a clone of wildmidi(1) that is missing a majority of the
+features.
+
+```
+$ cd examples/player/
+$ cargo run /tmp/D_E1A1.MID
+```
+
+
+# Tests
+
+The WildMIDI C library maintains some global state, so tests should **not** be
+run in parallel. Running tests consecutively can be achieved by invoking
+cargo-test as:
+
+```
+cargo test -- --test-threads=1
+```
+
+
+# TODO
+
+- [ ] Valid MIDI blob for use in testing 'load' and the methods of 'Midi'.