Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Victor committed Oct 17, 2014
1 parent 952cb47 commit 7ea6106
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
Chip8
=====

CHIP 8 emulator written in C
CHIP 8 emulator written in C.

Instructions
============
You need SDL library to run this program. Compile emulator using `gcc -lSDL chip8.c -o chip8`.

Key bindings
============
You can modify all key bindings in chip8.h file.

Key | Action
----|-------
p | Pause/unpause
b | Toggle debugging
i | Output emulator info (registers, etc.) to the console
n | Execute next instruction (while in pause mode)
h | Halt the emulator

Keyboard
========
Chip8 was using hex keyboard, which isn't available now. Instead use 1-4, q-r, a-f, z-v for input.

Bugs & problems
===============
Please report any bugs & problems in the issues section! This will help me improve the emulator

0 comments on commit 7ea6106

Please sign in to comment.