Miroirs/waterfoul
1
0
Fork 0
mirror of https://github.com/colby-swandale/waterfoul synced 2025-01-29 20:34:21 +01:00
Code Issues Projects Releases Packages Wiki Activity

updated README to reflect changes to working emulator & fixed typo

Browse source
This commit is contained in:
Colby Swandale 2016-08-14 23:19:22 +10:00 • committed by GitHub
parent 40eb4829a9
commit 7ae56c04ed
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -3,7 +3,7 @@ Waterfoul is a Gameboy emulator written in Ruby-lang. It is just a casual excers
of the device and how it works.
## Requirements
The [sdl2](https://www.libsdl.org/download-2.0.php) library is currenty used to render pixels. Most platforms have packages avaliable, else see the [here](https://wiki.libsdl.org/Installation). This library is required and needs to be installed before you can run the emulator.
The [sdl2](https://www.libsdl.org/download-2.0.php) library is currenty used to render pixels. Most platforms have packages avaliable, else see [here](https://wiki.libsdl.org/Installation). This library is required and needs to be installed before you can run the emulator.
## Can it play roms?
Yes! but the list of roms that i know work is very limited to just Tetris, Super Mario Land and Pokemon Red. But a lot of work is being put into making other games compatable. The device does run the internal boot program succesfully and is passing test programs sucesfully (barggs).
@ -11,9 +11,11 @@ Yes! but the list of roms that i know work is very limited to just Tetris, Super
## Testing
If you wish to run the test suite, download the source code (make sure to run `bundle install`) and run `bundle exec rspec`
## I Want to run it anyway
If you wish to see the emulator in action, download a rom online (it is required even though the game wont run) which typically have a .gb extension and place it onto your local file system.
## How do i run the emulator?
If you wish to see the emulator in action, download a rom online which typically have a .gb extension and place it onto your local file system. To start the emulator:
`bundle exec exe/waterfoul start <path to rom>`
Make sure to bundle install first.
The boot program will be executed by default, if you wish to skip it add `--skip-boot` as an option.