Skip to content

Commit

Permalink
Updated README.md to contain links to all other documents
Browse files Browse the repository at this point in the history
  • Loading branch information
ducalex committed Oct 30, 2024
1 parent b125acc commit ba84bfc
Showing 1 changed file with 18 additions and 27 deletions.
45 changes: 18 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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._


Expand Down Expand Up @@ -88,24 +84,18 @@ The roms must be packed with [LCD-Game-Shrinker](https://github.com/bzhxx/LCD-Ga

## Wifi

To use wifi you will need to create a `/retro-go/config/wifi.json` config file. Its content should look like this:

````json
{
"ssid": "my-network",
"password": "my-password"
}
````
To use wifi you will need to create a `/retro-go/config/wifi.json` config file. You can define up to 4 different networks, then selectable in the menu. Its content should look like this:

Multiple networks can be defined using the following format (then selectable in the Options menu):
````json
{
"ssid0": "my-network",
"password0": "my-password",
"ssid1": "my-network",
"ssid1": "my-other-network",
"password1": "my-password",
"ssid2": "my-network",
"password2": "my-password"
"ssid2": "my-third-network",
"password2": "my-password",
"ssid3": "my-last-network",
"password3": "my-password"
}
````

Expand Down Expand Up @@ -165,12 +155,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.
Expand Down

0 comments on commit ba84bfc

Please sign in to comment.