chip-8

chip-8 emulator

add breakout.ch8

Arjun Choudhary contact@arjunchoudhary.com

commit: bc8ebe3 parent: ee92b22

2 files changed, 15 insertions(+), 6 deletions(-)
MODREADME.md+15-6
ADDbreakout.ch8+0-0
MOD · README.md +15 -6
--- a/README.md
+++ b/README.md
@@ -1,17 +1,26 @@
-This is a CHIP-8 Virtual Machine implementation in C, utilizing SDL for graphical output. It supports running validw `.ch8` files, with the resolution scaled to 20x over the original for better usability. 
+## Overview
 
-Timer and sound are not yet implemented, but adding them is straightforward. The original CHIP-8 system produced a simple 1 bit beep sound.
+This is a CHIP-8 Virtual Machine implementation in C, uses SDL for the input and window. This was only done as a learning exercise to implement the fundamental opcode fetch -> decode -> execute lifecycle and learn some basic emulation stuff. Do not use this as a reference implementation.
 
+- Supports running `.ch8` files, with the resolution scaled to 20x from the original.
+- Timer and sound are not yet implemented, but adding them is straightforward. The original CHIP-8 system produced a simple 1 bit beep sound.
+
+## Local Setup
+
+You do need to install SDL on your system. So on something like fedora that would be.
+
+```
+sudo dnf install SDL2-devel -y
+```
+
+The Makefile just links against that. There is a breakout.ch8, it's specifically Breakout by Caremlo Cortez, 1979. More roms can easily be found on the interwebs.
 
-### Usage
 ```
-git clone git clone git://git.arjunchoudhary.com/chip8_c
 make
 ./chip8 /path/to/rom_file.ch8
 ```
 
-### Resources
-This was only done as a learning exercise to implement the fundamental opcode fetch -> decode -> execute lifecycle. Do not use this as a reference implementation. Resources I used for this project were:-
+## Resources
 
 - https://en.wikipedia.org/wiki/CHIP-8
 - http://devernay.free.fr/hacks/chip8/C8TECH10.HTM#4.0
ADD · breakout.ch8 +0 -0
--- a/breakout.ch8
+++ b/breakout.ch8