Added submodule filesHEADmaster

1 files changed, 170 insertions, 0 deletions

diff --git a/gearboy/README.md b/gearboy/README.md
new file mode 100644
index 00000000..058ee94f
--- /dev/null
+++ b/gearboy/README.md
@@ -0,0 +1,170 @@
+# Gearboy
+
+[![Gearboy CI](https://github.com/drhelius/Gearboy/workflows/Gearboy%20CI/badge.svg)](https://github.com/drhelius/Gearboy/actions)
+
+Gearboy is a cross-platform Game Boy / Game Boy Color emulator written in C++ that runs on Windows, macOS, Linux, BSD, iOS, Raspberry Pi and RetroArch.
+
+This is an open source project with its ongoing development made possible thanks to the support by these awesome [backers](backers.md).
+
+Please, consider [sponsoring](https://github.com/sponsors/drhelius) and following me on [Twitter](https://twitter.com/drhelius) for updates.
+
+If you find a bug or want new features, you can help me [openning an issue](https://github.com/drhelius/Gearboy/issues). 
+
+----------
+
+## Downloads
+
+- **Windows**: [Gearboy-3.4.0-Windows.zip](https://github.com/drhelius/Gearboy/releases/download/gearboy-3.4.0/Gearboy-3.4.0-Windows.zip)
+  + NOTE: You may need to install the [Microsoft Visual C++ Redistributable](https://go.microsoft.com/fwlink/?LinkId=746572)
+- **macOS**:
+  + `brew install --cask gearboy`
+  + Or install manually: [Gearboy-3.4.0-macOS.zip](https://github.com/drhelius/Gearboy/releases/download/gearboy-3.4.0/Gearboy-3.4.0-macOS.zip)
+- **Linux**: [Gearboy-3.4.0-Linux.tar.xz](https://github.com/drhelius/Gearboy/releases/download/gearboy-3.4.0/Gearboy-3.4.0-Linux.tar.xz)
+  + NOTE: You may need to install `libsdl2` and `libglew`
+- **RetroArch**: [Libretro core documentation](https://docs.libretro.com/library/gearboy/).
+
+## Features
+
+- Accurate CPU emulation, passes cpu_instrs.gb from blargg's tests.
+- Accurate instruction and memory timing, passes instr_timing.gb and mem_timing.gb from blargg's tests.
+- Supported cartridges: ROM, ROM + RAM, MBC1, MBC2, MBC3 + RTC, MBC5, HuC-1 and MBC1M (multicart).
+- Accurate LCD controller emulation with correct timings and priorities including mid-scanline effects.
+- Game Boy Color support.
+- LCD screen ghosting effect as seen in the original Game Boy.
+- LCD dot matrix effect.
+- Sound emulation using SDL Audio and [Gb_Snd_Emu library](https://www.slack.net/~ant/libs/audio.html#Gb_Snd_Emu).
+- Battery powered RAM save support.
+- Save states.
+- Compressed rom support (ZIP).
+- Bootrom (bios) support.
+- *Game Genie* and *GameShark* cheat support.
+- Supported platforms (standalone): Windows, Linux, BSD, macOS, Raspberry Pi and iOS.
+- Supported platforms (libretro): Windows, Linux, macOS, Raspberry Pi, Android, iOS, tvOS, PlayStation Vita, PlayStation 3, Nintendo 3DS, Nintendo GameCube, Nintendo Wii, Nintendo WiiU, Nintendo Switch, Emscripten, Classic Mini systems (NES, SNES, C64, ...), OpenDingux, RetroFW and QNX.
+- Full debugger with just-in-time disassembler, cpu breakpoints, memory access breakpoints, code navigation (goto address, JP JR and CALL double clicking), debug symbols, memory editor, IO inspector and VRAM viewer including tiles, sprites, backgrounds and palettes.
+- Windows and Linux *Portable Mode* by creating a file named `portable.ini` in the same directory as the application binary.
+- Support for modern game controllers through [gamecontrollerdb.txt](https://github.com/gabomdq/SDL_GameControllerDB) file located in the same directory as the application binary.
+
+<img src="http://www.geardome.com/files/gearboy/gearboy_debug_01.png" width="880" height="455">
+
+## Build Instructions
+
+### Windows
+
+- Install Microsoft Visual Studio Community 2019 or later.
+- Open the Gearboy Visual Studio solution `platforms/windows/Gearboy.sln` and build.
+- You may want to use the `platforms/windows/Makefile` to build the application using MinGW.
+
+### macOS
+
+- Install Xcode and run `xcode-select --install` in the terminal for the compiler to be available on the command line.
+- Run these commands to generate a Mac *app* bundle:
+
+``` shell
+brew install sdl2
+cd platforms/macos
+make dist
+```
+
+### Linux
+
+- Ubuntu / Debian:
+
+``` shell
+sudo apt-get install build-essential libsdl2-dev libglew-dev
+cd platforms/linux
+make
+```
+
+- Fedora:
+
+``` shell
+sudo dnf install @development-tools gcc-c++ SDL2-devel glew-devel
+cd platforms/linux
+make
+```
+
+### BSD
+
+- NetBSD:
+
+``` shell
+su root -c "pkgin install gmake pkgconf SDL2 glew"
+cd platforms/bsd
+gmake
+```
+
+### iOS
+
+- Install latest Xcode for macOS.
+- Build the project `platforms/ios/Gearboy.xcodeproj`.
+- Run it on real hardware using your iOS developer certificate. Make sure it builds on *Release* for better performance.
+
+### Libretro
+
+- Ubuntu / Debian:
+
+``` shell
+sudo apt-get install build-essential
+cd platforms/libretro
+make
+```
+
+- Fedora:
+
+``` shell
+sudo dnf install @development-tools gcc-c++
+cd platforms/libretro
+make
+```
+
+### Raspberry Pi 4 - Raspbian (Desktop)
+
+``` shell
+sudo apt install build-essential libsdl2-dev libglew-dev
+cd platforms/raspberrypi4
+make
+```
+
+### Raspberry Pi 2 & 3 - Raspbian (CLI)
+
+- Install and configure [SDL 2](http://www.libsdl.org/download-2.0.php) for development:
+
+``` shell
+sudo apt-get update
+sudo apt-get upgrade
+sudo apt-get install build-essential libfreeimage-dev libopenal-dev libpango1.0-dev libsndfile-dev libudev-dev libasound2-dev libjpeg-dev libtiff5-dev libwebp-dev automake
+cd ~
+wget https://www.libsdl.org/release/SDL2-2.0.12.tar.gz
+tar zxvf SDL2-2.0.12.tar.gz
+cd SDL2-2.0.12 && mkdir build && cd build
+../configure --disable-pulseaudio --disable-esd --disable-video-mir --disable-video-wayland --disable-video-x11 --disable-video-opengl --host=armv7l-raspberry-linux-gnueabihf
+make -j 4
+sudo make install
+```
+
+- Install libconfig library dependencies for development: `sudo apt-get install libconfig++-dev`
+- Use `make -j 4` in the `platforms/raspberrypi3/x64/` folder to build the project.
+- Use `export SDL_AUDIODRIVER=ALSA` before running the emulator for the best performance.
+- Gearboy generates a `gearboy.cfg` configuration file where you can customize keyboard and gamepads. Key codes are from [SDL](https://wiki.libsdl.org/SDL_Keycode).
+
+## Accuracy Tests
+
+Compared to other emulators: [see here](http://tasvideos.org/EmulatorResources/GBAccuracyTests.html).
+
+Tests from [blargg's test roms](https://github.com/retrio/gb-test-roms):
+
+![cpu_instrs.gb](http://www.geardome.com/files/gearboy/gearboy_001.png)![insrt_timing.gb](http://www.geardome.com/files/gearboy/gearboy_002.png)![lcd_sync.gb](http://www.geardome.com/files/gearboy/gearboy_003.png)![dmg_sound.gb](http://www.geardome.com/files/gearboy/gearboy_032.png)![cgb_sound.gb](http://www.geardome.com/files/gearboy/gearboy_033.png)![mem_timing.gb](http://www.geardome.com/files/gearboy/gearboy_memtiming2.png)
+
+## Screenshots
+
+![Screenshot](http://www.geardome.com/files/gearboy/gearboy_004.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_006.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_008.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_022.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_013.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_023.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_015.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_029.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_011.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_024.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_017.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_016.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_034.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_026.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_018.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_025.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_021.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_027.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_019.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_020.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_031.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_028.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_007.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_009.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_010.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_005.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_012.png)![Screenshot](http://www.geardome.com/files/gearboy/gearboy_014.png)
+
+## Contributors
+
+Thank you to all the people who have already contributed to Gearboy!
+
+[![Contributors](https://contrib.rocks/image?repo=drhelius/gearboy)]("https://github.com/drhelius/gearboy/graphs/contributors)
+
+## License
+
+Gearboy is licensed under the GNU General Public License v3.0 License, see [LICENSE](LICENSE) for more information.