Add README.md

mbStavola · Sep 16, 2017 · 3d22531 · 3d22531
1 parent d5f6f14
commit 3d22531
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# Alvin
+A mad cute CHIP-8 emulator for funsies.
+
+## Quick Start
+Simply use `cargo build` and provide `alvin` with the path to your CHIP-8 program: 
+
+```
+$ cargo build --release
+$ ./target/release/alvin --file /path/to/your/program
+```
+
+If you're looking for some CHIP-8 software to run, here are some links:
+- http://www.pong-story.com/chip8/