From 30fc903ce2911fa207462ea54669ca3e2c30b6e1 Mon Sep 17 00:00:00 2001 From: Alex Duchesne Date: Wed, 30 Oct 2024 11:31:07 -0400 Subject: [PATCH] Updated README.md to contain links to all other documents --- README.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 608559f9..b55561b2 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,15 @@ - [Installation](#installation) - [Usage](#usage) - [Issues](#issues) -- [Theming](#theming) -- [Building](#building) +- [Development](#development) - [Acknowledgements](#acknowledgements) - [License](#license) # Description Retro-Go is a firmware to play retro games on ESP32-based devices (officially supported are -ODROID-GO and MRGC-G32). The project consists of a launcher and half a dozen applications that -have been heavily optimized to reduce their cpu, memory, and flash needs without reducing -compatibility! - -Get started in [BUILDING.md](BUILDING.md) +ODROID-GO and MRGC-G32, check [this list for other devices](components/retro-go/README.md)). +The project consists of a launcher and half a dozen applications that have been heavily +optimized to reduce their cpu, memory, and flash needs without reducing compatibility! ### Supported systems: - Nintendo: **NES, SNES (slow), Gameboy, Gameboy Color, Game & Watch** @@ -56,10 +53,9 @@ Get started in [BUILDING.md](BUILDING.md) 3. Select retro-go in the files list and flash it. ### Generic ESP32 -This method is intended to be used when .fw support isn't available (when porting to a new device) or undesirable (devices with smaller flash). - 1. (optional) Port retro-go to your device ([PORTING.md](PORTING.md)) - 2. Build a .img file (refer to [Building Retro-Go](#building) below) - 3. Flash the image: `esptool.py write_flash --flash_size detect 0x0 retro-go_*.img` +This method is intended to be used when .fw support isn't available (when [porting to a new device](PORTING.md)) or undesirable (devices with smaller flash). + 1. Build a .img file (refer to [Building Retro-Go](BUILDING.md)) + 2. Flash the image: `esptool.py write_flash --flash_size detect 0x0 retro-go_*.img` _Note: Your particular device may require extra steps (like holding a button during power up), different esptool flags, or modifying base.sdkconfig._ @@ -165,12 +161,13 @@ of losing data when powering down too quickly. Also note that when *resuming* a to a save state if present. -# Theming -Instructions moved to [THEMING.md](THEMING.md). +# Development +If you wish to build or modify Retro-Go, you can find help in the following documents: +- Build instructions in [BUILDING.md](BUILDING.md) +- Theming instructions [THEMING.md](THEMING.md) +- Porting instructions in [PORTING.md](PORTING.md) -# Building -To build retro-go, refer to [BUILDING.md](BUILDING.md). # Acknowledgements - The NES/GBC/SMS emulators and base library were originally from the "Triforce" fork of the [official Go-Play firmware](https://github.com/othercrashoverride/go-play) by crashoverride, Nemo1984, and many others.