Add documentation
This commit is contained in:
16
README.md
16
README.md
@@ -3,21 +3,23 @@ chip8-rs
|
||||
|
||||
Yet another chip8 emulator written in rust \o/
|
||||
|
||||
## TODO
|
||||
If you encounter any problems, I encourage you to open a PR!
|
||||
|
||||
+ Expand on this README
|
||||
+ Add some documentation
|
||||
+ Add sound for beeper
|
||||
+ Fix tests for input
|
||||

|
||||
|
||||
## Games
|
||||
Due to legal reasons, I can't provide any games nor links to them.
|
||||
But they can be easily found by using a search engine!
|
||||
|
||||
## System Dependencies
|
||||
|
||||
`sdl2` together with its dependencies are required to be installed on your hostmachine.
|
||||
On Arch-based distros you can use these packages:
|
||||
`sdl2 sdl2_gfx sdl2_image sdl2_mixer sdl2_ttf`
|
||||
|
||||
## Credits
|
||||
## TODO
|
||||
[ ] Add Beeper Sound
|
||||
|
||||
## Credits
|
||||
For this project I used the help from the following sites:
|
||||
+ [Chip-8 Technical Reference](http://devernay.free.fr/hacks/chip8/C8TECH10.HTM#3.0)
|
||||
+ [How to write an emulator (CHIP-8 interpreter)](http://www.multigesture.net/articles/how-to-write-an-emulator-chip-8-interpreter/)
|
||||
|
||||
Reference in New Issue
Block a user