aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRaghuram Subramani <raghus2247@gmail.com>2023-10-21 22:03:46 +0530
committerGitHub <noreply@github.com>2023-10-21 22:03:46 +0530
commit886ca74879e25812ea8285b8b69c5f97547440d3 (patch)
treebccb62b8d79ad230dfe8aeface2b8cfdf1eca5e5
parent31e3a562fe4a44f4367e4398745e48b6d5f688ba (diff)
Update README.md
-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!