From 9d92c3cf7f29a46b2d6e3de2c922f2707ff40292 Mon Sep 17 00:00:00 2001 From: Joshua Goins Date: Wed, 30 Mar 2022 10:33:26 -0400 Subject: [PATCH] Expand README --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 97d151e..1ce0b35 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,27 @@ mirror](https://img.shields.io/badge/mirror-GitHub-black.svg?logo=github)](https [![ryne.moe mirror](https://img.shields.io/badge/mirror-ryne.moe-red.svg?logo=git)](https://git.ryne.moe/redstrate/chip8) -A chip8 emulator that I implemented in C++. It only implements the SCHIP instruction set, and can play many modern roms found online. There's a basic memory viewer and debugger available as well. +This is a CHIP-8 emulator that I implemented in C++! + +Right now it only emulates the SCHIP instruction set, but it can already play many modern roms found online. There's a basic memory viewer and debugger available as well. + +My goal is not to create an extremely fast or optimized emulator, but be easy to read and understand for those who wish to +create their own CHIP-8 emulator. ![example result](misc/output.png) +# Usage + +It should compile out of the box on Windows, macOS and Linux and it includes a basic [dear imgui interface](https://github.com/ocornut/imgui). There's also +some ROMs included in the repository for convenience. Once you click on a ROM, it will start immediately. + +## Debugger + +Using the debugger you can step instruction by instruction, stop or restart the program and see the instruction being +executed and the surrounding program. Unfortunately it's not very advanced at the moment. + +## Compiler + This emulator also comes with a basic compiler that takes a C-style language as input and can spit out valid CHIP-8 code: ``` var count = 3;