From 19c1a01cb563bbfc340464a0b7f79484e0da88db Mon Sep 17 00:00:00 2001 From: Franck STAUFFER Date: Mon, 3 Aug 2020 15:12:45 +0200 Subject: [PATCH] Add information in README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 720ad5c..e4dd28b 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ # CHIP-8 + +## Compile-time options + +You can tweak some variables: +- `SCALE`: Increase the size of pixels +- `WAIT`: Time waited between two opcodes in microseconds + +You can set them in the CPPFLAGS of the Makefile with `-DWAIT=100 -DSCALE=20` + +## How-to run + +``` +make +./bin/chip8 ROM +``` + +## Find ROMs + +You can find ROMs [here](https://github.com/dmatlack/chip8/tree/master/roms). + +## Test ROM + +https://github.com/corax89/chip8-test-rom