Skip to content

Commit f8759ce

Browse files
authored
Update README.md to include ROM compatibility section
1 parent 0d4e232 commit f8759ce

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
5. [Customization](#customization)
2323
1. [Keys](#keys)
2424
2. [Debug Keys](#debug-keys)
25-
6. [Further Documentation](#further-documentation)
25+
6. [ROM Compatibility](#rom-compatibility)
26+
7. [Further Documentation](#further-documentation)
2627

2728
## What is it?
2829

@@ -37,10 +38,15 @@ Super Chip 8 instruction set. Note that no additional configuration is
3738
needed to run a Super Chip 8 ROM - simply run the ROM the same way you
3839
would run a normal Chip 8 ROM.
3940

41+
There are two other versions of the emulator written in different languages:
42+
43+
* [Chip8Java](https://github.com/craigthomas/Chip8Java)
44+
* [Chip8C](https://github.com/craigthomas/Chip8C)
45+
4046

4147
## License
4248

43-
Please see the file called LICENSE.
49+
This project makes use of an MIT style license. Please see the file called LICENSE.
4450

4551

4652
## Installing
@@ -245,6 +251,15 @@ keys that impact the execution of the emulator.
245251
| `ESC` | Quits the emulator |
246252
247253
254+
## ROM Compatibility
255+
256+
Here are the list of public domain ROMs and their current status with the emulator.
257+
258+
| ROM Name | Works Correctly | Notes |
259+
| :---------------: | :----------------: | :---: |
260+
| MAZE | :heavy_check_mark: | |
261+
262+
248263
## Further Documentation
249264
250265
The best documentation is in the code itself. Please feel free to examine the

0 commit comments

Comments
 (0)