mirror of
https://github.com/Odebe/chip-8-crystal
synced 2024-11-16 19:48:23 +01:00
26 lines
709 B
Markdown
26 lines
709 B
Markdown
# cryp-8
|
|
|
|
chip-8 emulator
|
|
|
|
## Installation
|
|
First of all [Install Crystal](https://crystal-lang.org/install/), build with command
|
|
```shell script
|
|
shards install && shards build
|
|
```
|
|
|
|
## Usage
|
|
Run and enjoy (or not).
|
|
```shell script
|
|
> ./bin/cryp-8 -h
|
|
Usage: cryp-8 [arguments]
|
|
-d, --debug Enable debug logs
|
|
-r ROM_PATH, --rom=ROM_PATH Path to rom file
|
|
-h, --help Show this help
|
|
```
|
|
|
|
## Development & Contributing
|
|
|
|
**Do not touch my garbage!**
|
|
|
|
## Contributors
|
|
- [Дмитриев Odebe Михаил](https://github.com/Odebe) - creator and maintainer
|