chip-8
chip-8 emulatorchore: update readme
| 2 files changed, 18 insertions(+), 0 deletions(-) | |||
|---|---|---|---|
| MOD | README.md | +18 | -0 |
| ADD | finito.webm | +0 | -0 |
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+This is a CHIP-8 Virtual Machine implementation in C, utilizing SDL for graphical output. It supports running validw `.ch8` files, with the resolution scaled to 20x over the original for better usability.
+
+Timer and sound are not yet implemented, but adding them is straightforward. The original CHIP-8 system produced a simple 1 bit beep sound.
+
+
+### Usage
+```
+git clone git clone git://git.arjunchoudhary.com/chip8_c
+make
+./chip8 /path/to/rom_file.ch8
+```
+
+### Resources
+This was only done as a learning exercise to implement the fundamental opcode fetch -> decode -> execute lifecycle. Do not use this as a reference implementation. Resources I used for this project were:-
+
+- https://en.wikipedia.org/wiki/CHIP-8
+- http://devernay.free.fr/hacks/chip8/C8TECH10.HTM#4.0
+- https://wiki.libsdl.org/TutorialsADD · finito.webm +0 -0--- a/finito.webm
+++ b/finito.webm