waterfoul/README.md
Colby Swandale c4194ad39e Updated README.md
updated README with some basic documentation, testing and requirements
2016-05-08 17:41:44 +10:00

801 B

Waterfoul

Waterfoul is a Gameboy emulator written in Ruby-lang. It is just a casual excersize by myself to learn the internals of the device and how it works.

Requirements

The sdl2 library is currenty used to render pixels. Most platforms have packages avaliable, else see the here. This library is required and needs to be installed before you can run the emulator.

Can it play roms?

No. But a lot of work is being put into making a compatable emulator. The device does boot the internal program succesfully and is running emulator testing programs sucesfully (barggs).

Testing

If you wish to run the test suite, download the source code (make sure to run bundle instlall) and run bundle exec rspec