diff options
-rw-r--r-- | README.md | 17 |
1 files changed, 7 insertions, 10 deletions
@@ -1,27 +1,24 @@ # CHIP8Emu -An emulator for CHIP-8 written in C++  -## Building +## About The Project -### Requirements +CHIP8Emu is an emulator for the 1977 interpreter CHIP-8 written in C++. It aims to make games designed for the same playable on modern hardware. -* CMake -* SDL2 -* Make - -### Running the build +## Compilation & Usage +For compilation, you need Clang, CMake, GNUMake, and SDL2. With them installed, run the following. ```sh mkdir build; cd build cmake .. make ``` -## Syntax +Replace `[scale]` with your preferred display scaling, `[delay]` with the your preferred delay, and `[ROM]` with the path to the game you intend to play. ```sh -./chip8emu <Scale> <Delay> <ROM> +./chip8emu [scale] [delay] [ROM] ``` +<br> # Thanks! |