From 3c6310d4e3b6cc79875853e72c476371b709d505 Mon Sep 17 00:00:00 2001 From: robshape Date: Wed, 12 Apr 2023 21:48:25 +0200 Subject: [PATCH] docs: Add installation guide --- README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 53 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 937e5e9..051981b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # FinUI FinUI is a fork of [MinUI](https://github.com/shauninman/union-minui). MinUI is a -focused custom launcher for the Anbernic RG35XX (and possibly others to come). FinUI -adds additional features on top of MinUI. +focused custom launcher for the Anbernic RG35XX. FinUI adds additional features on +top of MinUI. ![MinUI](./github/minui-menu-gbc.png) @@ -37,9 +37,49 @@ You can [grab the latest version here](https://github.com/shauninman/union-minui - +## Installation guide + +The following section explains how to install MinUI using macOS, without having to +download any additional tools. + +### Prerequisites + +- A new 64GB microSD card from a reputable brand +- The offical Anbernic RG355XX firmware (`35XX-64GB230309EN.IMG`) +- A [MinUI release](https://github.com/shauninman/union-minui/releases) +- An [administrator user account](https://support.apple.com/guide/mac-help/change-users-groups-settings-mtusr001/mac) +- [Full Disk Access](https://support.apple.com/guide/mac-help/change-privacy-security-settings-on-mac-mchl211c911f/13.0/mac/13.0) +for the app `Terminal.app` + +### Install MinUI + +1. Connect your microSD card to your Mac +2. Start the app `Terminal` +3. Run the command `diskutil list` and identify your microSD by looking at the `SIZE` +column. It is `/dev/disk4` in this example. +4. Run the command `diskutil unmountDisk /dev/disk4` +5. Unzip the RG35XX firmware to your desktop and then run the command `cd ~/Desktop` +in the Terminal +6. Run the command `sudo dd bs=1m if=35XX-64GB230309EN.IMG of=/dev/disk4` to flash +the firmware onto your microSD. Enter your user account password if prompted. Wait. +7. Run the command `diskutil list` again and identify the largest partition on your +microSD by looking at the `SIZE` column. It is `/dev/disk4s4` in this example. Note +that it differs from the previous path! +8. Run `sudo diskutil eraseVolume FAT32 ROMS /dev/disk4s4` to format that partition +as `FAT32` with the name `ROMS`. Enter your user account password if prompted. Wait. +9. You should now have a `misc` and a `ROMS` disk connected to your Mac. If you +don't then try reconnecting your microSD card to your Mac. +10. Unzip the MinUI release to your desktop +11. Copy `dmenu.bin` to the root of the `misc` disk. Copy `MinUI.zip` and the `Bios`, +`Roms`, `Saves` folders to the root of the `ROMS` disk. Optionally, follow the additional +instructions in the MinUI README if you wish. +12. Finally, run `dot_clean -m /Volumes/misc` and `dotclean -m /Volumes/ROMS` to +remove any dot-underscore files created by macOS on your microSD. + +Done. Insert your microSD to your RG35XX and boot it up! + ## FinUI TODO -- Add macOS CLI installation instructions - Add "mark as finished" OR "add as favorite" to menu - Improve battery capacity readings (2100 mAh, 2600 mAh, 3500 mAh) - Refactor Tools to Settings @@ -49,3 +89,13 @@ You can [grab the latest version here](https://github.com/shauninman/union-minui - Include extras in release by default - Move toolchain to repo: - Release using GitHub action: +- Automate installation guide + +## Disclaimer + +This software is provided without warranty of any kind. In no event shall the authors +or contributors be liable for any claim, damages, or other liability, arising from, +out of, or in connection with this software, the use of this software, or other +dealings with this software. + +Use at your own risk.