build: Include installation instructions in release

This commit is contained in:
robshape 2023-04-23 17:27:17 +02:00
parent 77957493ca
commit 2c99cf3ad1
4 changed files with 76 additions and 58 deletions

View file

@ -50,60 +50,6 @@ You can [grab the latest version here](https://github.com/shauninman/union-minui
| Adjust brightness | MENU + VOLUME_DOWN/VOLUME_UP | | Adjust brightness | MENU + VOLUME_DOWN/VOLUME_UP |
| Add to Favorites (from menu) | SELECT | | Add to Favorites (from menu) | SELECT |
## Installation
The following section explains how to install MinUI using macOS, without having to
download any additional tools. These instructions currently only work with 64GB microSD
cards. Other sizes require additional partitioning steps that this guide does not
cover yet.
### 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
1. Start the app `Terminal`
1. Run the command `diskutil list` and identify your microSD by looking at the `SIZE`
column. It is `/dev/disk4` in this example.
1. Run the command `diskutil unmountDisk /dev/disk4`
1. Unzip the RG35XX firmware to your desktop and then run the command `cd ~/Desktop`
in the Terminal
1. 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.
1. 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!
1. 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.
1. 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.
1. Unzip the MinUI release to your desktop
1. Copy `dmenu.bin` to the root of the `misc` disk. Copy `MinUI.zip` and the `Bios`,
`Emus`, `Roms`, `Saves`, `Tools` folders to the root of the `ROMS` disk. Optionally,
follow the additional instructions in the MinUI README if you wish.
1. Finally, to remove dotfiles created by macOS on your microSD, run:
```shell
dot_clean -m /Volumes/misc
rm -fr /Volumes/misc/.feventsd
rm -fr /Volumes/misc/.Spotlight-V100
rm -fr /Volumes/misc/.Trashes
dot_clean -m /Volumes/ROMS
rm -fr /Volumes/ROMS/.feventsd
rm -fr /Volumes/ROMS/.Spotlight-V100
rm -fr /Volumes/ROMS/.Trashes
```
Done. Insert your microSD to your RG35XX and boot it up!
## Development ## Development
### Prerequisites ### Prerequisites
@ -123,7 +69,6 @@ Run `./start-toolchain.sh` and then `make all` in the Docker container shell.
- ~~Refactor Tools to Settings~~ - ~~Refactor Tools to Settings~~
- ~~Add to Favorites~~ - ~~Add to Favorites~~
- ~~Adjust battery capacity readings (2100 mAh, 2600 mAh, 3500 mAh)~~ - ~~Adjust battery capacity readings (2100 mAh, 2600 mAh, 3500 mAh)~~
- Automate installation and update
- Update visible MinUI strings and boot logo (show that it is the FinUI fork) - Update visible MinUI strings and boot logo (show that it is the FinUI fork)
- Release using GitHub Actions - Release using GitHub Actions
- Adjust overclocking and CPU usage (to maximize battery life) - Adjust overclocking and CPU usage (to maximize battery life)

View file

@ -102,14 +102,14 @@ zip:
cd ./build/PAYLOAD && zip -r MinUI.zip .system cd ./build/PAYLOAD && zip -r MinUI.zip .system
mv ./build/PAYLOAD/MinUI.zip ./build/BASE mv ./build/PAYLOAD/MinUI.zip ./build/BASE
cd ./build/BASE && zip -r ../../releases/$(RELEASE_NAME)-base.zip Bios Roms Saves dmenu.bin MinUI.zip README.txt cd ./build/BASE && zip -r ../../releases/$(RELEASE_NAME)-base.zip Bios Roms Saves dmenu.bin MinUI.zip README.txt INSTALL.txt
cd ./build/EXTRAS && zip -r ../../releases/$(RELEASE_NAME)-extras.zip Bios Emus Roms Saves Tools README.txt cd ./build/EXTRAS && zip -r ../../releases/$(RELEASE_NAME)-extras.zip Bios Emus Roms Saves Tools README.txt
rm -fr ./build/FULL rm -fr ./build/FULL
mkdir ./build/FULL mkdir ./build/FULL
cp -fR ./build/BASE/* ./build/FULL/ cp -fR ./build/BASE/* ./build/FULL/
cp -fR ./build/EXTRAS/* ./build/FULL/ cp -fR ./build/EXTRAS/* ./build/FULL/
cd ./build/FULL && zip -r ../../releases/$(RELEASE_NAME)-full.zip Bios Emus Roms Saves Tools dmenu.bin MinUI.zip cd ./build/FULL && zip -r ../../releases/$(RELEASE_NAME)-full.zip Bios Emus Roms Saves Tools dmenu.bin MinUI.zip INSTALL.txt
echo "$(RELEASE_NAME)" > ./build/latest.txt echo "$(RELEASE_NAME)" > ./build/latest.txt

73
skeleton/BASE/INSTALL.txt Normal file
View file

@ -0,0 +1,73 @@
################
# Installation #
################
The following guide explains how to install FinUI using macOS, without having to download additional
software. These instructions only work with 64GB microSD cards. Other sizes require partitioning
steps that this guide does not cover yet.
#################
# Prerequisites #
#################
- A new 64GB microSD card from a reputable brand
- The official Anbernic RG355XX firmware (35XX-64GB230309EN.IMG)
- A FinUI release
- A user account with administrator privileges (https://support.apple.com/guide/mac-help/change-users-groups-settings-mtusr001/mac)
- Full Disk Access for the app "Terminal" (https://support.apple.com/guide/mac-help/change-privacy-security-settings-on-mac-mchl211c911f/13.0/mac/13.0)
#################
# Install FinUI #
#################
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"
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 this path differs from
the previous path!
8. Run the command "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 do not then try to
reconnect your microSD.
10. Unzip the FinUI release to your desktop
11. From the release, copy "dmenu.bin" to the root of the "misc" disk. Then copy "MinUI.zip" and the
"Bios", "Emus", "Roms", "Saves", "Tools" folders to the root of the "ROMS" disk.
12. Finally, to clean up you microSD, run the following commands:
dot_clean -m /Volumes/misc
dot_clean -m /Volumes/ROMS
rm -fr /Volumes/misc/.feventsd /Volumes/misc/.Spotlight-V100 /Volumes/misc/.Trashes
rm -fr /Volumes/ROMS/.feventsd /Volumes/ROMS/.Spotlight-V100 /Volumes/ROMS/.Trashes
Done. Insert your microSD to your RG35XX and boot it up!
######################
# Update FinUI/MinUI #
######################
1. Connect your microSD card, containing your existing FinUI/MinUI installation, to your computer
2. Unzip the latest FinUI release
3. From the release, copy and replace "dmenu.bin" in the root of the "misc" disk. Then copy and
replace "MinUI.zip" and the "Bios", "Emus", "Roms", "Saves", "Tools" folders in the root of the
"ROMS" disk.
Done. Insert your microSD to your RG35XX and boot it up!

View file

@ -1404,7 +1404,7 @@ static int POW_readBatteryStatus(void) {
if (battery == BATTERY_2100MAH) { if (battery == BATTERY_2100MAH) {
return ((voltage_now / 10000) - 310); // 310-410 return ((voltage_now / 10000) - 310); // 310-410
} else if (battery == BATTERY_2600MAH) { } else if (battery == BATTERY_2600MAH) {
return ((voltage_now / 10000) - 308); // 308-413? Seems incorrect... return ((voltage_now / 10000) - 308); // 308-414? Seems incorrect...
} else if (battery == BATTERY_3500MAH) { } else if (battery == BATTERY_3500MAH) {
// ???-??? // ???-???
} }