<commit_before>Chip-8 interpreter in Rust
==
This is an educational/toy project for me to get some more practice coding in
Rust / organizing modules, testing etc. Feedback is more than welcome!

Status
==
* All 35 original Chip-8 instructions are implemented.
* Graphics are implemented with [Piston](http://www.piston.rs/).
* Sound is not supported but is faked by updating the title bar with a note
symbol when sound should be playing.

Spec
==
I used these two resources as the spec for my vm:
* [Cowgod's Chip-8 Technical Reference v1.0](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM)
* [Mastering Chip-8 By <NAME>](http://mattmik.com/chip8.html)
They were both incredibly helpful so thanks to the authors!

Licence
==
MIT<commit_msg>Add usage to Readme<commit_after>Chip-8 interpreter in Rust
==
This is an educational/toy project for me to get some more practice coding in
Rust / organizing modules, testing etc. Feedback is more than welcome!

Status
==
* All 35 original Chip-8 instructions are implemented.
* Graphics are implemented with [Piston](http://www.piston.rs/).
* Sound is not supported but is faked by updating the title bar with a note
symbol when sound should be playing.

Usage
==

```
> cargo build
> ./target/chip8 [path_to_ch8_binary]
```

Controls are mapped to these 16 buttons:

  1  |  2  |  3  |  4
-----|-----|-----|-----
  Q  |  W  |  E  |  R
  A  |  S  |  D  |  F
  Z  |  X  |  C  |  V

Spec
==
I used these two resources as the spec for my vm:
* [Cowgod's Chip-8 Technical Reference v1.0](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM)
* [Mastering Chip-8 By <NAME>](http://mattmik.com/chip8.html)
They were both incredibly helpful so thanks to the authors!

Licence
==
MIT
{'fraction_non_alphanumeric': 0.10793465577596266, 'fraction_numerical': 0.019836639439906652, 'mean_word_length': 3.5013123359580054, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7159147', 'n_tokens_mistral': 593, 'n_tokens_neox': 555, 'n_words': 220}