<commit_before>Chip-8 emulator in Rust
==
This is an emulator with a GUI Built on top of the `chip8_vm` library.

See the `chip8_vm` directory's [README](https://github.com/jakerr/chip8-rust/blob/master/src/chip8_vm/README.md) for instructions on including the VM in your own project.

![screen shot - pong2](https://cloud.githubusercontent.com/assets/322861/6091672/b7db0636-aefa-11e4-84f3-24d66e06dbba.png)
*Running [PONG2](http://www.chip8.com/?page=109) from chip8.com program pack*

Status
==
* 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.

Dependencies
==
The provided UI depends on SDL2 via [Piston](http://www.piston.rs/) for it's graphics. See: [Piston Tutorials - Getting Started](https://github.com/PistonDevelopers/Piston-Tutorials/tree/master/getting-started) for help setting up your development environment.

Usage
==

```
> cargo build
> cargo run [path_to_ch8_rom]
```

Controls are mapped to these 16 buttons:

  1  |  2  |  3  |  4
-----|-----|-----|-----<commit_msg>Fix broken link to chip8_vm directory<commit_after>Chip-8 emulator in Rust
==
This is an emulator with a GUI Built on top of the `chip8_vm` library.

See the [chip8_vm](https://github.com/jakerr/chip8-rust/tree/master/chip8_vm) directory for instructions on including the VM in your own project.

![screen shot - pong2](https://cloud.githubusercontent.com/assets/322861/6091672/b7db0636-aefa-11e4-84f3-24d66e06dbba.png)
*Running [PONG2](http://www.chip8.com/?page=109) from chip8.com program pack*

Status
==
* 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.

Dependencies
==
The provided UI depends on SDL2 via [Piston](http://www.piston.rs/) for it's graphics. See: [Piston Tutorials - Getting Started](https://github.com/PistonDevelopers/Piston-Tutorials/tree/master/getting-started) for help setting up your development environment.

Usage
==

```
> cargo build
> cargo run [path_to_ch8_rom]
```

Controls are mapped to these 16 buttons:

  1  |  2  |  3  |  4
-----|-----|-----|-----
{'fraction_non_alphanumeric': 0.1334527541424093, 'fraction_numerical': 0.045230631437527986, 'mean_word_length': 4.031531531531532, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4566888', 'n_tokens_mistral': 832, 'n_tokens_neox': 748, 'n_words': 224}