summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..48c3c23
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,12 @@
+This is a simple CHIP-8 virtual machine written in C.
+This project is mainly an exercise in emulator programming.
+
+CHIP-8 was an interpreted bytecode to allow games to be easily programmed
+for mid-1970s 8-bit microcomputers.
+
+Compiles with gcc or clang. Not tested on Windows.
+
+Requires SDL2 for input and rendering.
+
+Compile with `gcc main.c -lSDL2 -o chip8` on Linux. A sample is included, and can be
+loaded via `./chip8 Fishie.ch8`