From 3d22531c529aa3074652d87c5d15e3e87ca0080a Mon Sep 17 00:00:00 2001 From: Matthew Stavola Date: Sat, 16 Sep 2017 11:32:47 -0700 Subject: [PATCH] Add README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..21324c6 --- /dev/null +++ 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/ \ No newline at end of file