Added documentation for most targets

It's very incomplete, I only took what was available in config.h or a quick web search.

components/retro-go/README.md

@@ -3,6 +3,20 @@
 Retro-Go's shared library (or framework) provides an easy way to port emulators to the ODROID-GO and the ESP32 in general.
 
 
+# Supported Devices
+
+| Name                                                  | Status |
+|-------------------------------------------------------|--------|
+| [esplay-micro](targets/esplay-micro/docs/README.md)   |   |
+| [esplay-s3](targets/esplay-s3/docs/README.md)         |   |
+| [mrgc-g32](targets/mrgc-g32/docs/README.md)           |   |
+| [mrgc-gbm](targets/mrgc-gbm/docs/README.md)           |   |
+| [odroid-go](targets/odroid-go/docs/README.md)         |   |
+| [gtpy-gamer](targets/qtpy-gamer/docs/README.md)       |   |
+| [retro-esp32](targets/retro-esp32/docs/README.md)     |   |
+| [sdl2](targets/sdl2/docs/README.md)                   |   |
+
+
 # Credits
 
 ## Retro-Go
@@ -11,11 +25,11 @@ Retro-Go's shared library (or framework) provides an easy way to port emulators
 ## Go-Play
 - crashoverride / hardkernel
 
+## cJSON
+- Dave Gamble (DaveGamble)
+
 ## lodepng
 - Lode Vandevenne (lvandeve)
 
-## printf
-- Marco Paland (mpaland)
-
 # License
-Zlib
+[LICENSE](LICENSE)

components/retro-go/targets/README.md

@@ -0,0 +1,12 @@
+# Targets
+
+| Name                                              | Status            |
+|---------------------------------------------------|-------------------|
+| [esplay-micro](esplay-micro/docs/README.md)       |   |
+| [esplay-s3](esplay-s3/docs/README.md)             |   |
+| [mrgc-g32](mrgc-g32/docs/README.md)               |   |
+| [mrgc-gbm](mrgc-gbm/docs/README.md)               |   |
+| [odroid-go](odroid-go/docs/README.md)             |   |
+| [gtpy-gamer](qtpy-gamer/docs/README.md)           |   |
+| [retro-esp32](retro-esp32/docs/README.md)         |   |
+| [sdl2](sdl2/docs/README.md)                       |   |

components/retro-go/targets/esplay-micro/config.h

@@ -1,18 +1,3 @@
-// REF: https://www.makerfabs.com/esplay-micro-v2.html
-// This port developed for the Micro V2 listed above. Compatibility with the elusive V1 is unknown.
-
-// WORK IN PROGRESS!
-// Issues: Menu, L, and R aren't properly mapped yet.
-
-// Parts:
-// - ESP32-WROVER-B (SoC 16MB Flash + 8MB PSRAM)
-// - PCF8574 I2C GPIO (To connect the extra buttons)
-// - UDA1334A (I2S DAC)
-// - YT240L010 (ILI9341 LCD)
-// - TP4054 (Lipo Charger IC)
-// - CH340C (USB to Serial)
-// - 3.5mm Headphone jack 0_o
-
 // Target definition
 #define RG_TARGET_NAME             "ESPLAY-MICRO"
 

components/retro-go/targets/esplay-micro/docs/README.md

@@ -0,0 +1,32 @@
+# ESPlay Micro V2
+- Status: WORK IN PROGRESS!
+- Ref: https://www.makerfabs.com/esplay-micro-v2.html
+
+This port developed for the Micro V2 listed above. Compatibility with the elusive V1 is unknown.
+
+Issues: Menu, L, and R aren't properly mapped yet.
+
+# Hardware info
+- ESP32-WROVER-B (SoC 16MB Flash + 8MB PSRAM)
+- PCF8574 I2C GPIO (To connect the extra buttons)
+- UDA1334A (I2S DAC)
+- YT240L010 (ILI9341 LCD)
+- TP4054 (Lipo Charger IC)
+- CH340C (USB to Serial)
+- 3.5mm Headphone jack 0_o
+
+The following snippet was in the `config.h`, might contain still useful information.
+````
+// Experimental. Caused "Menu" to be mapped to a D-pad direction.
+//#define RG_GPIO_GAMEPAD_X           GPIO_NUM_NC
+//#define RG_GPIO_GAMEPAD_Y           GPIO_NUM_NC
+//#define RG_GPIO_GAMEPAD_SELECT      GPIO_NUM_0
+//#define RG_GPIO_GAMEPAD_START       GPIO_NUM_36
+//#define RG_GPIO_GAMEPAD_A           GPIO_NUM_32
+//#define RG_GPIO_GAMEPAD_B           GPIO_NUM_33
+//#define RG_GPIO_GAMEPAD_MENU        GPIO_NUM_35
+//#define RG_GPIO_GAMEPAD_OPTION      GPIO_NUM_NC
+````
+
+# Images
+![device.jpg](device.jpg)

components/retro-go/targets/esplay-s3/config.h

@@ -1,5 +1,3 @@
-// REF: https://wiki.odroid.com/odroid_go/odroid_go
-
 // Target definition
 #define RG_TARGET_NAME             "ESPLAY-S3"
 

components/retro-go/targets/esplay-s3/docs/README.md

@@ -0,0 +1,8 @@
+# Esplay-S3
+- Status:
+- Ref:
+
+# Hardware
+- Module: ESP32-S3
+
+# Images

components/retro-go/targets/mrgc-g32/config.h

@@ -1,34 +1,3 @@
-// REF: https://www.myretrogamecase.com/products/game-mini-g32-esp32-retro-gaming-console-1
-
-// Parts:
-// - ESP32-WROVER-B (SoC)
-// - STM32F071cbu7 (Apparently buttons, charging, LED, backlight?)
-// - NXP 1334A (I2S DAC)
-// - CS5082E (Power controller)
-// - P8302E (Amplifier)
-// - YT280S002 (ILI9341 LCD)
-//
-
-/**
- * IO35 - MENU BTN
- * IO25 - I2S DAC
- * IO26 - I2S DAC
- * IO15 - SD CARD
- * IO2 - SD CARD
- * IO0 - SELECT BTN
- * IO4 - AMP EN
- * IO5 - LCD SPI CS
- * IO12 - LCD DC
- * IO18 - SPI CLK
- * IO23 - SPI MOSI
- * IO21 - STM32F (I2C)
- * IO22 - STM32F (I2C)
- *
- * IO27 - resistor then STM32?
- *
- * Power LED is connected to the STM32
- */
-
 // Target definition
 #define RG_TARGET_NAME             "MRGC-G32"
 

components/retro-go/targets/mrgc-g32/docs/README.md

@@ -0,0 +1,34 @@
+# MyRetroGameCase G32
+- Status: Fully supported
+- Ref: https://www.myretrogamecase.com/products/game-mini-g32-esp32-retro-gaming-console-1
+
+**WARNING**: As of 2023 all links have been taking over by spam/scam!
+
+# Hardware info
+- ESP32-WROVER-B (SoC)
+- STM32F071cbu7 (Apparently buttons, charging, LED, backlight?)
+- NXP 1334A (I2S DAC)
+- CS5082E (Power controller)
+- P8302E (Amplifier)
+- YT280S002 (ILI9341 LCD)
+
+ * IO35 - MENU BTN
+ * IO25 - I2S DAC
+ * IO26 - I2S DAC
+ * IO15 - SD CARD
+ * IO2 - SD CARD
+ * IO0 - SELECT BTN
+ * IO4 - AMP EN
+ * IO5 - LCD SPI CS
+ * IO12 - LCD DC
+ * IO18 - SPI CLK
+ * IO23 - SPI MOSI
+ * IO21 - STM32F (I2C)
+ * IO22 - STM32F (I2C)
+ *
+ * IO27 - resistor then STM32?
+ *
+ * Power LED is connected to the STM32
+
+# Images
+![device.jpg](device.jpg)

components/retro-go/targets/mrgc-gbm/config.h

@@ -1,22 +1,3 @@
-// REF: https://www.myretrogamecase.com/products/game-mini-esp32
-// Original firmware source code: GBA ESP32 link on https://www.myretrogamecase.com/pages/retro-handheld-gaming-firmware
-// Source code is in the "esplay-base-firmware" directory of the .rar archive in the above link.
-
-// Note: As of Late 2022, the owner of this shop has vanished from the net. Orders may not be fulfilled.
-
-// Known issues:
-// Battery meter needs to be configured.
-// Cropping most noticeable on NES, SNES, Genesis, PC Engine.
-// Scaling option for above should eventually be removed or changed if downscaling is added.
-// Disk LED does nothing (or isn't mapped yet) and should be removed for this target.
-// Sometimes takes more than one attempt to flash. (Stock bootloader problem? Hardware?)
-// Would benefit from a custom theme for small screens.
-
-
-// Parts:
-// Unknown ESP-32 (Most likely ESP32-WROVER-B) (SOC)
-
-
 // Target definition
 #define RG_TARGET_NAME             "MRGC-GBM"
 

components/retro-go/targets/mrgc-gbm/docs/README.md

@@ -0,0 +1,25 @@
+# MyRetroGameCase GBM
+- Status:
+- Ref: https://www.myretrogamecase.com/products/game-mini-esp32
+
+**WARNING**: As of 2023 all links have been taking over by spam/scam!
+
+Original firmware source code: GBA ESP32 link on https://www.myretrogamecase.com/pages/retro-handheld-gaming-firmware
+
+// Source code is in the "esplay-base-firmware" directory of the .rar archive in the above link.
+
+// Note: As of Late 2022, the owner of this shop has vanished from the net. Orders may not be fulfilled.
+
+# Hardware info
+- Unknown ESP-32 (Most likely ESP32-WROVER-B) (SOC)
+
+# Known issues:
+- Battery meter needs to be configured.
+- Cropping most noticeable on NES, SNES, Genesis, PC Engine.
+- Scaling option for above should eventually be removed or changed if downscaling is added.
+- Disk LED does nothing (or isn't mapped yet) and should be removed for this target.
+- Sometimes takes more than one attempt to flash. (Stock bootloader problem? Hardware?)
+- Would benefit from a custom theme for small screens.
+
+# Images
+![device.jpg](device.jpg)

components/retro-go/targets/odroid-go/config.h

@@ -1,5 +1,3 @@
-// REF: https://wiki.odroid.com/odroid_go/odroid_go
-
 // Target definition
 #define RG_TARGET_NAME             "ODROID-GO"
 

components/retro-go/targets/odroid-go/docs/README.md

@@ -0,0 +1,12 @@
+# ODROID-GO
+- Status: Fully supported
+- Ref: https://wiki.odroid.com/odroid_go/odroid_go
+
+The original Retro-Go target!
+
+# Hardware info
+- Module: ESP32-WROVER-B
+- Schematic: [schematic.pdf](schematic.pdf)
+
+# Images
+![device.jpg](device.jpg)

components/retro-go/targets/qtpy-gamer/config.h

@@ -1,5 +1,3 @@
-// REF: https://wiki.odroid.com/odroid_go/odroid_go
-
 // Target definition
 #define RG_TARGET_NAME             "QTPY ESP32"
 

components/retro-go/targets/qtpy-gamer/docs/README.md

@@ -0,0 +1,11 @@
+# QTPY ESP32
+
+- Status:
+- Ref:
+
+# Hardware info
+- Module: ESP32-???
+
+# Images
+
+![device.jpg](device.jpg)

components/retro-go/targets/retro-esp32/config.h

@@ -1,7 +1,5 @@
-// REF: https://wiki.odroid.com/odroid_go/odroid_go
-
 // Target definition
-#define RG_TARGET_NAME             "ODROID-GO"
+#define RG_TARGET_NAME             "RETRO-ESP32"
 
 // Storage and Settings
 #define RG_STORAGE_DRIVER           1                   // 0 = Host, 1 = SDSPI, 2 = SDMMC, 3 = USB, 4 = Flash

components/retro-go/targets/retro-esp32/docs/README.md

@@ -0,0 +1,9 @@
+# Retro-ESP32
+- Status:
+- Ref: https://github.com/retro-esp32/
+
+# Hardware info
+- Module: ESP32-WROVER-B
+
+# Images
+![device.jpg](device.jpg)

components/retro-go/targets/sdl2/config.h

@@ -1,5 +1,3 @@
-// REF: https://wiki.libsdl.org/
-
 // Target definition
 #define RG_TARGET_NAME             "SDL2"
 

components/retro-go/targets/sdl2/docs/README.md

@@ -0,0 +1,5 @@
+# SDL2
+- Status: Development only
+- Ref: https://wiki.libsdl.org/
+
+SDL2 port is intended for development purposes, it isn't useful to end users.