commit e67a488d7d925621f64a6b63c3ef36ba3552e62e from: Witcher01 date: Sun Aug 1 18:52:51 2021 UTC more README commit - add1b745a56591b99ad089d0a965815784210dd0 commit + e67a488d7d925621f64a6b63c3ef36ba3552e62e blob - 464f7e3a00c437c877adc82d28760fca553c0787 blob + 9b2d085de4ee52243690e9527d2cdcc0dd2036d2 --- README.md +++ README.md @@ -4,10 +4,16 @@ yac8e is yet another Chip8 emulator, written in Rust. It will use [minifb](https://docs.rs/minifb/0.19.3/minifb/) for video and keyboard inputs. +Documentation used: +- http://devernay.free.fr/hacks/chip8/C8TECH10.HTM +- https://github.com/mattmikolay/chip-8/wiki/Mastering-CHIP%E2%80%908 +- https://github.com/mattmikolay/chip-8/wiki/CHIP%E2%80%908-Technical-Reference + ## TODO - [ ] [logging](https://github.com/borntyping/rust-simple_logger) -- [ ] tests +- [ ] tests ([reference](https://github.com/starrhorne/chip8-rust/blob/master/src/processor_test.rs)) - [ ] [video output](https://docs.rs/minifb/0.19.3/minifb/struct.Window.html#method.update_with_buffer) - [ ] handle [keyboard inputs](https://docs.rs/minifb/0.19.3/minifb/struct.Window.html#method.get_keys_pressed) - [ ] proper [error handling](https://docs.rs/thiserror/1.0.26/thiserror/) +- [ ] reformat instruction parsing (maybe like [this](https://github.com/starrhorne/chip8-rust/blob/master/src/processor.rs#L132))