Skip to content

Commit 1c5a630

Browse files
committed
Update README to reflect changes and add section on contributing
1 parent bc6ccd7 commit 1c5a630

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ This menu works exactly the same as the main menu in terms of
264264
[controls](#controls).
265265

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

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

370+
## Contributing
371+
372+
Do you find an issue in this test suite that you think you can fix? Feel free to
373+
submit a PR! Here's how to build the project, assuming you have Nodejs and NPM
374+
installed:
375+
376+
```bash
377+
git clone git@github.com:Timendus/chip8-test-suite.git
378+
cd chip8-test-suite
379+
npm install
380+
```
381+
```bash
382+
npm run build # Build the source to `bin/chip8-test-suite.8o`
383+
npm run build-binary # Build the above plus the binary `bin/chip8-test-suite.ch8`
384+
npm run build-html # Build `bin/chip8-test-suite.8o` and `docs/index.html`
385+
npm run build-all # Build all of the above
386+
```
387+
388+
Note that the `npm run build*` scripts use the MacOS command `pbcopy` to copy
389+
the resulting Octo source file to the clipboard. Depending on your OS this may
390+
not work properly. Edit `package.json` and remove this part from `scripts` ->
391+
`build` if you get errors:
392+
393+
```
394+
&& cat bin/chip8-test-suite.8o | pbcopy
395+
```
396+
370397
## Community response 😄
371398

372399
[![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)

0 commit comments

Comments
 (0)