Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.29 KB

readme.md

File metadata and controls

27 lines (18 loc) · 1.29 KB

Chit8

Chit8 is a toy emulator / interpreter for the CHIP8 virtual machine written in the Rust programming language.

Currently it only sports a very basic disassembler and a semi-complete CPU emulation without display and real keyboard.

This project has served as my introduction to the Rust language and tooling. As such, the code quality may vary.

Requirements
Building

Clone the repository and run cargo build [--release] to retrieve dependencies and build the emulator (optionally in release mode). Run chit8.exe <path-to-rom> to execute the emulator.

Alternatively use cargo run <path-to-rom> to run the emulator.

Tests

Use cargo test to run the test suite. Currently only the CPU opcodes are covered by tests.

Docs

Use cargo doc to generate documentation.

Acknowledgements