aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 78d9c16..6fd677c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
# CHIP8Emu
An emulator for CHIP-8 written in C++
+
+## Building
+
+### Requirements
+
+* CMake
+* SDL2
+* Make
+
+### Running the build
+
+```sh
+mkdir build; cd build
+cmake ..
+make
+```
+
+## Syntax
+```sh
+./chip8emu <Scale> <Delay> <ROM>
+```
+
+# Thanks!