paoda
/
gb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

chore(readme): add build instructions 

closes #1
This commit is contained in:
Rekai Nyangadzayi Musuka 2022-10-26 21:05:00 -03:00
parent 85940c8744
commit 3841d3a98c
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,10 +1,9 @@
# Rekai's Gameboy Emulator # Rekai's Gameboy Emulator
[![Build Status](https://ci.paoda.moe/api/badges/paoda/gb/status.svg)](https://ci.paoda.moe/paoda/gb)
### Status ### Status
* From [Blargg Test ROMs](https://github.com/L-P/blargg-test-roms/) * From [Blargg Test ROMs](https://github.com/L-P/blargg-test-roms/)
* [x] cpu_instrs * [x] cpu_instrs
* [ ] instr_timing (kind of) * [x] instr_timing
* [x] mem_timing * [x] mem_timing
* [x] mem_timing-2 * [x] mem_timing-2
* [ ] dmg_sound (partial) * [ ] dmg_sound (partial)
@ -21,9 +20,15 @@
Supports: ROM-only, MBC1, MBC2, MBC3 and MBC5 games. Supports: ROM-only, MBC1, MBC2, MBC3 and MBC5 games.
### Compiling
This project was last successfully built on [Rust 1.64.0](https://github.com/rust-lang/rust/tree/1.64.0)
1. `git clone https://github.com/paoda/gb`
2. `cd gb`
3. `cargo run --release`
### Controls ### Controls
Controls are defined [here](https://git.musuka.dev/paoda/gb/src/branch/main/src/joypad.rs#L114) Controls are defined [here](https://github.com/paoda/gb/blob/85940c874460b9cb31bf9b8211bf7dda596d114a/src/joypad.rs#L114)
Key | Button Key | Button
--- | --- --- | ---