update readme to reflect addition of cryboy codebase

README.md

@@ -1,8 +1,10 @@
 <p align="center"><img width="200" src="README/crab.png"></p>
 
-Crab is a Game Boy Advance emulator written in Crystal. Currently, this project is still clearly a work-in-progress, although some games are currently playable.
+Crab is a Game Boy, Game Boy Color, and Game Boy Advance emulator written in Crystal. Game Boy and Game Boy Color emulation are very accurate, while Game Boy Advance is considered playable in many games.
 
-This would not be possible without [GBATEK](http://problemkaputt.de/gbatek.htm), [Tonc](https://www.coranac.com/tonc), [mGBA](https://mgba.io/), or the wonderful emudev community.
+The Game Boy and Game Boy Color emulator come from my [CryBoy](https://github.com/mattrberry/CryBoy) project, which has been ported into this codebase to reduce common logic and bugs between the two. The one downside here is the longer build time thanks to Crystal's slow compilation in release mode.
+
+The Game Boy and Game Boy Color work would not be possible without the [Pan Docs](https://gbdev.io/pandocs), [izik's opcode table](https://izik1.github.io/gbops), the [gbz80 opcode reference](https://rednex.github.io/rgbds/gbz80.7.html), [The Cycle-Accurate Game Boy Docs](https://github.com/AntonioND/giibiiadvance/blob/master/docs/TCAGBD.pdf), or gekkio's [Game Boy: Complete Technical Reference](https://gekkio.fi/files/gb-docs/gbctr.pdf). The Game Boy Advance work would not be possible without [GBATEK](http://problemkaputt.de/gbatek.htm), [Tonc](https://www.coranac.com/tonc), [mGBA](https://mgba.io/), or the wonderful emudev community.
 
 <p align="center"><img width="800" src="README/GoldenSun.png"></p>
 
@@ -16,41 +18,80 @@ After cloning the repository, all you'll need to do is run `shards build --relea
 
 Running the emulator simply consists of `bin/crab /path/to/bios /path/to/rom`.
 
-At the moment, the BIOS _is_ a required argument, although I may ship with an open-source replacement BIOS at some point in the future. If you cannot dump the official BIOS from your own console, you can pick up [Normatt's replacement BIOS](https://github.com/Nebuleon/ReGBA/tree/master/bios) or the [one created by DenSinH and fleroviux](https://github.com/Cult-of-GBA/BIOS). Both of these BIOSes should be compatible in 99% of use-cases.
+At the moment, the BIOS is required for GBA games, while the GBC BIOS can be omitted for GB and GBC games. If you omit the GBC BIOS for a GB game, it will select a default 4-color palette that will not be the one typically set by the GBC BIOS.
+
+I may ship the emulator with an open-source replacement GBA BIOS at some point in the future. If you cannot dump the official BIOS from your own console, you can pick up [Normatt's replacement BIOS](https://github.com/Nebuleon/ReGBA/tree/master/bios) or the [one created by DenSinH and fleroviux](https://github.com/Cult-of-GBA/BIOS). Both of these BIOSes should be compatible in most cases, although the official BIOS will always be the most accurate.
+
+### Keybindings
+
+The current keybindings are tuned for my personal preferences. If the following layout diagram doesn't work for you, the "a" and "b" keys are also bound to their appropriate keys, as are the arrow keys. Controllers are also supported.
+
+![](README/keyboard.png)
+
+### Pixel-Accurate GB / GBC Rendering
+
+To enable the experimental FIFO renderer (as opposed to the scanline renderer), you can run the emulator with the `--fifo` flag. The current FIFO implementation should work identically to the scanline renderer with the exception that it does not render sprites on column 0 of the LCD. However, it will play games like Prehistorik Man more accurately than the scanline renderer would since that game relies on a cycle-accurate PPU implementation.
 
 ## Features and Remaining Work
 
 ### Features
-
-- Accurate sound emulation (both Direct Sound and PSGs)
-- GLSL shaders for color reproduction
-- PPU features
-  - Modes 0-5 are mostly implemented
-  - Affine backgrounds and sprites
-  - Alpha blending
-  - Windowing
-- CPU core
-  - Passing [armwrestler](https://github.com/destoer/armwrestler-gba-fixed)
-  - Passing [FuzzARM](https://github.com/DenSinH/FuzzARM)
-  - Passing [gba-suite](https://github.com/jsmolka/gba-suite)
-- Storage
-  - Flash and SRAM implemented (although Golden Sun refuses to save..)
+- GB / GBC
+  - Accurate sound emulation
+  - GLSL shaders for color reproduction
+  - Controller support
+  - Passing [blargg's CPU tests](https://github.com/retrio/gb-test-roms/tree/master/cpu_instrs)
+  - Passing [blargg's instruction timing tests](https://github.com/retrio/gb-test-roms/tree/master/instr_timing)
+  - Passing [blargg's memory timing tests](https://github.com/retrio/gb-test-roms/tree/master/mem_timing)
+  - Passing [blargg's Game Boy Color sound tests](https://github.com/retrio/gb-test-roms/tree/master/cgb_sound)
+  - Passing [mooneye-gb timer tests](https://github.com/Gekkio/mooneye-gb/tree/master/tests/acceptance/timer)
+  - PPU draws background, window, and sprites
+  - PPU offers both scanline and FIFO rendering modes (behind a runtime flag)
+  - Save files work as intended, and are compatible with other emulators like BGB
+  - MBC1 cartridges are supported (except for multicarts)
+  - MBC2 cartridges are fully supported
+  - MBC3 cartridges are supported (except timers)
+  - MBC5 cartridges are supported
+  - Game Boy Color support, including HDMA, double-speed mode, and palettes
+- GBA
+  - Accurate sound emulation (both Direct Sound and PSGs)
+  - GLSL shaders for color reproduction
+  - Controller support
+  - PPU features
+    - Modes 0-5 are mostly implemented
+    - Affine backgrounds and sprites
+    - Alpha blending
+    - Windowing
+  - CPU core
+    - Passing [armwrestler](https://github.com/destoer/armwrestler-gba-fixed)
+    - Passing [FuzzARM](https://github.com/DenSinH/FuzzARM)
+    - Passing [gba-suite](https://github.com/jsmolka/gba-suite)
+  - Storage
+    - Flash and SRAM implemented
+  - Timers run effeciently on the scheduler
 
 ### Remaining Work
-
-- Timers need improvement
-- PPU
-  - Mosaic
-  - Blending code needs cleanup
-- Storage
-  - EEPROM
-  - Fix Flash for Golden Sun
-  - Game database to support odd cases like Classic NES
-- Timing
-  - Cycle counting
-  - DMA timing
-  - Prefetch
-  - Etc, etc, etc.
+- GB / GBC
+  - Picture processing
+    - Pixel FIFO
+      - I've made lots of progress into the FIFO renderer. There are still a couple of issues that I have yet to resolve, though. The main one that seems to be specific to the pixel FIFO renderer is that I don't render sprites on column 0 of the LCD, although I still do render the rest of the sprite in its correct position even if the sprite's x position is less than 8
+  - Misc
+    - MBCs
+      - MBC 5 rumble
+      - RTC (decide if I want it to stick with real time or CPU time, or make it configurable)
+      - Fixing an issue when ROMs misreport their size
+    - Other hardware bugs tested in blargg's test suite
+- GBA
+  - PPU
+    - Mosaic
+    - Blending code needs cleanup
+  - Storage
+    - EEPROM
+    - Game database to support odd cases like Classic NES and ROMs that misreport things like RTC
+  - Timing
+    - Cycle counting
+    - DMA timing
+    - Prefetch
+    - Etc, etc, etc.
 
 ## Special Thanks