Skip to content

Commit 143ca01

Browse files
committed
doc: add README
1 parent ef4a8cf commit 143ca01

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
### ProggerX/chipi-chapa
2+
# Monadic CHIP-8 emulator written in Haskell
3+
4+
Supports only CHIP-8 instructions for now.
5+
6+
## Installation
7+
#### Nix
8+
If you are lucky nix user, you can use flake in this repo.\
9+
chipi-chapa is also cached on [our cachix](https://balds.cachix.org)
10+
11+
#### No nix?
12+
Use cabal idk
13+
14+
## Usage
15+
- Run chip-8 ROM: `chipi-chapa <path-to-rom>`
16+
#### Debug
17+
- Set `CHIPI_CHAPA_DEBUG` env to anything, you will get additional output in stdout.
18+
19+
## Development
20+
Try `nix develop`.

0 commit comments

Comments
 (0)