Skip to content

Commit

Permalink
Add key bindings to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YushiOMOTE committed Jul 11, 2024
1 parent b141a2d commit ea99862
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,20 @@ $ cargo run --example pc <a ROM file>
The example runs the GameBoy emulator in Mac/Linux.
It depends on `libasound2-dev` and `libxcursor-dev`.

### Key bindings

| Keyboard | GameBoy |
|----------|---------|
| Right | Right |
| Left | Left |
| Up | Up |
| Down | Down |
| Z | A |
| X | B |
| Space | Select |
| Enter | Start |
| Escape | Close |

## Port it to a new environment

The library itself is environment independent. It can be even ported onto bare-metal. Once you implement environment-specific part, i.e. `Hardware` trait, you will get a GameBoy emulator for your environment.
Expand Down

0 comments on commit ea99862

Please sign in to comment.