Skip to content

Commit f4222d5

Browse files
committed
Restructure README introduction once again
1 parent eb96f18 commit f4222d5

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,27 @@
33
_A single ROM image containing six distinct tests that will aid you in developing
44
your own CHIP-8, SCHIP or XO-CHIP interpreter (or "emulator")_
55

6-
[Download the ROM here](./bin/chip8-test-suite.ch8?raw=true), give it a spin and
6+
* [Download the ROM here](./bin/chip8-test-suite.ch8?raw=true), give it a spin and
77
see if your interpreter is doing the right thing! 😄
8-
9-
Or [run the test suite in Octo](https://timendus.github.io/chip8-test-suite/) to
10-
see what it **should** be doing 🙄 (set to "Cosmac VIP" CHIP-8 mode)
8+
* Or [run the test suite in Octo](https://timendus.github.io/chip8-test-suite/) to
9+
see what it **should** be doing 🙄 (it's set to "Cosmac VIP" CHIP-8 mode)
1110

1211
![The test suite running in CHIP-8 mode on Octo](./pictures/animation.gif)
1312

14-
### Community response 😄
13+
## Table of contents
14+
15+
* [Introduction](#introduction)
16+
* [Controls](#controls)
17+
* [Auto-starting a specific test](#auto-starting-a-specific-test)
18+
* [About the tests](#about-the-tests)
19+
* [CHIP-8 splash screen](#chip-8-splash-screen)
20+
* [IBM logo](#ibm-logo)
21+
* [Corax89's opcode test](#corax89s-opcode-test) (improved version)
22+
* [Flags test](#flags-test)
23+
* [Quirks test](#quirks-test)
24+
* [Keypad test](#keypad-test)
25+
26+
## Community response 😄
1527

1628
[![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)
1729

@@ -21,14 +33,7 @@ see what it **should** be doing 🙄 (set to "Cosmac VIP" CHIP-8 mode)
2133

2234
[![Really nice to have new tests (flags, quirks). Especially the quirks. Fixing some bugs in my impl as we speak thanks to that.](./pictures/testimonial4.png)](https://www.reddit.com/r/EmuDev/comments/viri5r/comment/idugp4j/?utm_source=reddit&utm_medium=web2x&context=3)
2335

24-
### Available tests
25-
26-
* [CHIP-8 splash screen](#chip-8-splash-screen)
27-
* [IBM logo](#ibm-logo)
28-
* [Corax89's opcode test](#corax89s-opcode-test) (improved version)
29-
* [Flags test](#flags-test)
30-
* [Quirks test](#quirks-test)
31-
* [Keypad test](#keypad-test)
36+
## Introduction
3237

3338
I found it hard to find reliable sources on what is the right behaviour and what
3439
is not, especially with the subtle differences between the original "Cosmac VIP"

0 commit comments

Comments
 (0)