Skip to content

Commit

Permalink
Created readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GroobleDierne committed Jul 18, 2021
1 parent 7e0fc07 commit a7eda00
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Chip-8 emulator

A chip-8 emulator in the terminal written in Rust for Windows, may not work on other platforms.

The keyboard part is not implemented yet.

## Building

Simply run
> cargo build
## Running

On your terminal simply run the previously obtained file, you can add the path to a ROM as an argument if you want, if no path is provided a pong ROM will be loaded.
> chip8.exe C:\path\to\a\ROM

0 comments on commit a7eda00

Please sign in to comment.