diff --git a/README.md b/README.md index db518a3..03ba9b8 100644 --- a/README.md +++ b/README.md @@ -48,14 +48,14 @@ accuracy is important. ## SDL2 Example -An example implementation is given in peanut_sdl.c, which uses SDL2 to draw the -screen and take input. Run `cmake` or `make` in the ./examples/sdl2/ folder to -compile it. +The flagship example implementation is given in peanut_sdl.c, which uses SDL2 to +draw the screen and take input. Run `cmake` or `make` in the ./examples/sdl2/ +folder to compile it. -Execute in command line with `peanut-sdl game.gb` which will automatically -create the save file `game.sav` for the game if one isn't found. Or run with -`peanut-sdl game.gb save.sav` to specify a save file. Or even `peanut-sdl` to -create a *drop zone* window that you can drag and drop a ROM file to. +Run `peanut-sdl`, which creates a *drop-zone* window that you can drag and drop +a ROM file into. Alternatively, run in a terminal using `peanut-sdl game.gb`, +which will automatically create the save file `game.sav` for the game if one +isn't found. Or, run with `peanut-sdl game.gb save.sav` to specify a save file. ### Screenshot @@ -100,6 +100,15 @@ between 60 FPS and 30 FPS. Pressing 'b' will dump each frame as a 24-bit bitmap file in the current folder. See /screencaps/README.md for more information. +## Projects Using Peanut-GB + +In no particular order, and a non-exaustive list, the following projects use Peanut-GB. + +* [Pico-GB](https://github.com/YouMakeTech/Pico-GB) - Game Boy emulation on the Raspberry Pi RP2040 microcontroller. +* [Peanut_gb-RGFW](https://github.com/ColleagueRiley/Peanut_gb-RGFW) - A Gameboy emulator example for [RGFW](https://github.com/ColleagueRiley/RGFW). +* [CPBoy](https://github.com/diddyholz/CPBoy) - A Game Boy (DMG) emulator for the Classpad II (fx-CP400). +* [PlayGB](https://github.com/risolvipro/PlayGB) - A Game Boy emulator for Playdate, based on Peanut-GB. + ## Getting Started Documentation of function prototypes can be found at the bottom of [peanut_gb.h](peanut_gb.h#L3960).