Docs

README.md

@@ -2,47 +2,53 @@
 
 MinUI is a focused, custom launcher and libretro frontend for [a variety of retro handhelds](#supported-devices).
 
-<img src="github/minui-main.png" width=320 /> <img src="github/minui-menu-gbc.png" width=320 /> 
+<img src="github/minui-main.png" width=320 /> <img src="github/minui-menu-gbc.png" width=320 />
 
 ## Features
 
 - Simple launcher, simple SD card
 - No settings or configuration
 - No boxart, themes, or distractions
 - Automatically hides hidden files
-  and extension and region/version 
+  and extension and region/version
   cruft in display names
 - Consistent in-emulator menu with
   quick access to save states, disc
   changing, and emulator options
-- Automatically sleeps after 30 seconds 
+- Automatically sleeps after 30 seconds
   or press POWER to sleep (and wake)
 - Automatically powers off while asleep
   after two minutes or hold POWER for
   one second
 - Automatically resumes right where
   you left off if powered off while
   in-game, manually or while asleep
-- Resume from manually created, last 
-  used save state by pressing X in 
+- Resume from manually created, last
+  used save state by pressing X in
   the launcher instead of A
-- Streamlined emulator frontend 
+- Streamlined emulator frontend
   (minarch + libretro cores)
 - Single SD card compatible with
   multiple devices from different
   manufacturers
 
-You can [grab the latest version here](https://github.com/shauninman/MinUI/releases).
+**[Download the latest release](https://github.com/shauninman/MinUI/releases)**
 
-> Devices with a physical power switch
-> use MENU to sleep and wake instead of
-> POWER. Once asleep the device can safely
-> be powered off manually with the switch.
+## Installation
 
-## Supported consoles
+1. Download the latest release (base ZIP for your device)
+2. Extract to a freshly formatted FAT32 SD card
+3. Follow device-specific instructions in the included `README.txt`
+4. Insert SD card and boot your device
 
-Base:
+For detailed installation steps and device-specific setup, see the `README.txt` included in the base download.
 
+> [!TIP]
+> Devices with a physical power switch use MENU to sleep and wake instead of POWER. Once asleep, the device can be safely powered off with the switch.
+
+## Supported Consoles
+
+**Base consoles** (included with every release):
 - Game Boy
 - Game Boy Color
 - Game Boy Advance
@@ -51,11 +57,10 @@ Base:
 - Sega Genesis
 - PlayStation
 
-Extras:
-
+**Extra consoles** (optional download):
 - Neo Geo Pocket (and Color)
 - Pico-8
-- Pokémon mini
+- Pokémon mini
 - Sega Game Gear
 - Sega Master System
 - Super Game Boy
@@ -64,47 +69,42 @@ Extras:
 
 ## Supported Devices
 
-| Device | Added | Status |
-| -- | -- | -- |
-| Anbernic RG28xx | MinUI-20240429b-2 | Deprecated |
-| Anbernic RG34xx | MinUI-20241227-0 | Deprecated |
-| Anbernic RG34xxSP | MinUI-20250920-0 | Deprecated |
-| Anbernic RG35xx | MinUI-20230922b-2 | Deprecated |
-| Anbernic RG35xx Plus | MinUI-20240106b-0 | Deprecated |
-| Anbernic RG35xxH | MinUI-20240120b-1 | Deprecated |
-| Anbernic RG35xxSP | MinUI-20240525-0 | Deprecated |
-| Anbernic RG40xxH | MinUI-20240717-1 | Deprecated |
-| Anbernic RG40xxV | MinUI-20240831-0 | Deprecated | 
-| Anbernic RG CubeXX | MinUI-202401028-0 | Deprecated | 
-| GKD Pixel | MinUI-20240120b-1 | Deprecated |
-| M17 | MinUI-20231126b-2 | Deprecated |
-| MagicX XU Mini M | MinUI-20240831-0 | Deprecated | 
-| MagicX Mini Zero 28 | MinUI-20250111-0 | Deprecated |
-| Miyoo A30 | MinUI-20240705-0 | Deprecated |
-| Miyoo Flip | MinUI-20250111-0 | Deprecated |
-| Miyoo Mini | MinUI-20230922b-2 | Deprecated |
-| Miyoo Mini Flip | MinUI-20251023-0 | Deprecated |
-| Miyoo Mini Plus | MinUI-20230922b-2 | Deprecated |
-| Powkiddy RGB30 | MinUI-20231014b-1 | Deprecated |
-| Trimui Brick | MinUI-20241028-0 | Deprecated |
-| Trimui Smart | MinUI-20230922b-2 | Deprecated |
-| Trimui Smart Pro | MinUI-20231111b-2 | Deprecated |
+| Manufacturer | Device | Released | Status |
+|--------------|--------|----------|--------|
+| **Anbernic** | RG35XX | December 2022 | ✓ |
+| **Anbernic** | RG35XX Plus | November 2023 | ✓ |
+| **Anbernic** | RG35XXH | January 2024 | ✓ |
+| **Anbernic** | RG28XX | April 2024 | ✓ |
+| **Anbernic** | RG35XXSP | May 2024 | ✓ |
+| **Anbernic** | RG40XXH | July 2024 | ✓ |
+| **Anbernic** | RG40XXV | August 2024 | ✓ |
+| **Anbernic** | RG CubeXX | October 2024 | ✓ |
+| **Anbernic** | RG34XX | December 2024 | ✓ |
+| **Anbernic** | RG34XXSP | May 2025 | ✓ |
+| **Miyoo** | Mini | December 2021 | ✓ |
+| **Miyoo** | Mini Plus | February 2023 | ✓ |
+| **Miyoo** | A30 | May 2024 | ✓ |
+| **Miyoo** | Mini Flip | October 2024 | ✓ |
+| **Miyoo** | Flip | January 2025 | ✓ |
+| **Trimui** | Smart | October 2022 | ✓ |
+| **Trimui** | Smart Pro | November 2023 | ✓ |
+| **Trimui** | Brick | October 2024 | ✓ |
+| **Powkiddy** | RGB30 | August 2023 | ✓ |
+| **MagicX** | Mini Zero 28 | January 2025 | ✓ |
+| **GKD** | Pixel | January 2024 | Deprecated |
+| **Generic** | M17 | October 2023 | Deprecated |
+| **MagicX** | XU Mini M | May 2024 | Deprecated |
 
 > [!NOTE]
-> **Active** actively working on compatibility and improvements specific to this device  
-> **Maintained** inheriting improvements to common functionality  
-> **Deprecated** will be retired in a future update  
-> **Retired** removed from repo, no longer updated or packaged with new releases
-
-## Legacy versions
-
-The original Trimui Model S version of MinUI (2021/04/03-2021/08/06) has been archived [here](https://github.com/shauninman/MinUI-Legacy-Trimui-Model-S).
+> Deprecated devices will continue to work with current MinUI releases but will not receive new features or platform-specific fixes.
 
-The sequel, MiniUI for the Miyoo Mini (2022/04/20-2022/10/23), has been archived [here](https://github.com/shauninman/MiniUI-Legacy-Miyoo-Mini).
+---
 
-The return of MinUI for the original Anbernic RG35XX (2023/02/26-2023/03/26) has been archived [here](https://github.com/shauninman/MinUI-Legacy-RG35XX).
+## For Developers
 
-The current MinUI which introduced support for multiple devices starting with the Trimui Smart, Miyoo Mini (and Plus), and the original Anbernic RG35XX was released on [2023/09/22][init-release] with the initial functional commit 6 months earlier on [2023/03/27][init-commit].
+Want to build MinUI, create custom paks, or understand how it works?
 
-[init-release]:https://github.com/shauninman/MinUI/releases/tag/v20230922b-2
-[init-commit]:https://github.com/shauninman/MinUI/commit/53e0296ea5a2794290fb5783765af6cee0063445#diff-b993e61ab6e66a19b67c88cfb98261aa9267d250de8bb56463662f67aae1a558
+- **[Development Guide](docs/DEVELOPMENT.md)** - Building, testing, and contributing
+- **[Architecture Guide](docs/ARCHITECTURE.md)** - How MinUI works internally
+- **[Pak Development Guide](docs/PAKS.md)** - Creating custom emulator and tool paks
+- **[Platform Documentation](workspace/)** - Technical hardware details for each device