Skip to content

Commit

Permalink
Update README to reflect changes and add section on contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Timendus committed Dec 31, 2022
1 parent bc6ccd7 commit 1c5a630
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ This menu works exactly the same as the main menu in terms of
[controls](#controls).

The test will now run through a couple of steps, which you will see on the
screen as some garbage and a bunch of smiley faces. After about two seconds, you
screen as some garbage and a flickering pixel. After about two seconds, you
should see this screen:

![Showing the active quirks](./pictures/quirks.png)
Expand Down Expand Up @@ -367,6 +367,33 @@ ROM in memory starting from `0x200`. Additionally, you can also force the target
opcode by loading a value between 1 and 3 into memory at the address `0x1FE`
(510).

## Contributing

Do you find an issue in this test suite that you think you can fix? Feel free to
submit a PR! Here's how to build the project, assuming you have Nodejs and NPM
installed:

```bash
git clone [email protected]:Timendus/chip8-test-suite.git
cd chip8-test-suite
npm install
```
```bash
npm run build # Build the source to `bin/chip8-test-suite.8o`
npm run build-binary # Build the above plus the binary `bin/chip8-test-suite.ch8`
npm run build-html # Build `bin/chip8-test-suite.8o` and `docs/index.html`
npm run build-all # Build all of the above
```

Note that the `npm run build*` scripts use the MacOS command `pbcopy` to copy
the resulting Octo source file to the clipboard. Depending on your OS this may
not work properly. Edit `package.json` and remove this part from `scripts` ->
`build` if you get errors:

```
&& cat bin/chip8-test-suite.8o | pbcopy
```

## Community response 😄

[![DUDE THANKS! I was writing a CHIP-8 emulator and THIS HELPED ME SO FRICKING MUCH, THANKS! / same here, this is amazing](./pictures/testimonial1.png)](https://github.com/Timendus/chip8-test-suite/issues/1)
Expand Down

0 comments on commit 1c5a630

Please sign in to comment.