Skip to content

Commit

Permalink
Add controls to README docs
Browse files Browse the repository at this point in the history
  • Loading branch information
paulopacitti committed Jan 9, 2023
1 parent 1184c69 commit 8ddec17
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,21 @@
- Compile `core`: `cd core && cargo build`
- Compile and **run** the emulator: `cd frontend && cargo run <path-to-rom>`

### Controls
Controls in CHIP-8 implementations are based on a 4x4 keyboard. In `chip-r`, these are the controls:
```
Keyboard
|---|---|---|---|
| 1 | 2 | 3 | 4 |
|---|---|---|---|
| Q | W | E | R |
|---|---|---|---|
| A | S | D | F |
|---|---|---|---|
| Z | X | C | V |
|---|---|---|---|
```

### Resources
- I've built this to learn about emulation development and learn more about `rust`. Here's the guide that helped me through this journey: https://github.com/aquova/chip8-book
- `CHIP-8` op codes cheatsheet: http://devernay.free.fr/hacks/chip8/C8TECH10.HTM
Expand Down

0 comments on commit 8ddec17

Please sign in to comment.