docs(readme): use 'main' branch

instead of 'stable' for rolling updates and installation. This will
ironically be more stable.
This commit is contained in:
Luke Short 2025-06-29 10:59:37 -06:00
commit 7072cfed71
3 changed files with 12 additions and 12 deletions

View file

@ -743,7 +743,7 @@ These are tasks that need to happen before publishing a stable release.
- Add change log notes to the [CHANGELOG.md](CHANGELOG.md) file.
- Add upgrade notes to the [UPGRADES.md](CHANGELOG.md) file.
- For a new release, update the `rootfs/usr/lib/os-release-winesapos` file in the git repository with the new `VERSION` and `VERSION_ID` before building an image.
- Before building an alpha or beta build, enable the `[winesapos-rolling]` repository with `export WINESAPOS_ENABLE_REPO_ROLLING=true`.
- Before building a stable image, enable the stable `[winesapos]` repository with `--env WINESAPOS_ENABLE_REPO_ROLLING=false`.
- Create a "minimal" and "performance" release image (not "secure") using a [container build](#automated-container-build).
- Due to the "secure" image having a common LUKS container encryption key that would be shared, users are encouraged to do their own custom build of winesapOS to generate a unique key instead.
- Make sure that no tests failed by checking the exit/return code of the installation script. It should be zero. If not, that is how many tests have failed.

View file

@ -624,14 +624,14 @@ Instead of using a release build which is already made, advanced users may want
pacman -S git
```
4. Clone the [stable](https://github.com/winesapOS/winesapOS/tree/stable) branch and go to the "scripts" directory.
4. Clone the winesapOS repository and go to the "scripts" directory.
```
git clone --branch stable https://github.com/winesapos/winesapos.git
git clone https://github.com/winesapos/winesapos.git
cd ./winesapos/scripts/
```
5. Configure [environment variables](https://github.com/winesapOS/winesapOS/blob/stable/CONTRIBUTING.md#environment-variables-for-installation) to customize the build. At the very least, allow the build to work on bare-metal and define what ``/dev/<DEVICE>`` block device to install to. ***BE CAREFUL AS THIS WILL DELETE ALL EXISTING DATA ON THAT DEVICE!***
5. Configure [environment variables](https://github.com/winesapOS/winesapOS/blob/main/CONTRIBUTING.md#environment-variables-for-installation) to customize the build. At the very least, allow the build to work on bare-metal and define what ``/dev/<DEVICE>`` block device to install to. ***BE CAREFUL AS THIS WILL DELETE ALL EXISTING DATA ON THAT DEVICE!***
```
export WINESAPOS_BUILD_IN_VM_ONLY=false
@ -921,7 +921,7 @@ Upgrades are supported and recommended between all minor releases of winesapOS.
Where it makes sense, features are backported from newer versions of winesapOS. Bug and security fixes are also included to fix problems either with winesapOS itself or with upstream changes in Arch Linux. Even if a user never upgrades winesapOS, users will continue to get regular system upgrades from Arch Linux.
Before upgrading, please read the full [UPGRADE.md](https://github.com/winesapOS/winesapOS/blob/stable/UPGRADES.md) notes. This showcases what updates will happen automatically and what updates may need to be manually applied.
Before upgrading, please read the full [UPGRADE.md](https://github.com/winesapOS/winesapOS/blob/main/UPGRADES.md) notes. This showcases what updates will happen automatically and what updates may need to be manually applied.
Development builds do not support upgrades. Here are the releases that we do support upgrades on:
@ -935,10 +935,10 @@ Development builds do not support upgrades. Here are the releases that we do sup
Here is how to upgrade winesapOS. Do **NOT** use "Applications (bauh)" for upgrades, only for package installations.
- GUI = Launch the "winesapOS Upgrade" desktop shortcut.
- CLI = Launch the winesapOS upgrade script from the stable branch.
- CLI = Launch the winesapOS upgrade script from the main branch.
```
curl https://raw.githubusercontent.com/winesapOS/winesapOS/stable/scripts/winesapos-upgrade.sh | sudo -E bash
curl https://raw.githubusercontent.com/winesapOS/winesapOS/main/scripts/winesapos-upgrade.sh | sudo -E bash
```
#### Major Upgrades
@ -950,13 +950,13 @@ Here is how to upgrade winesapOS. Do **NOT** use "Applications (bauh)" for upgra
echo stick > /tmp/winesapos_user_name.txt
export WINESAPOS_UPGRADE_FILES=false
export WINESAPOS_UPGRADE_VERSION_CHECK=false
curl https://raw.githubusercontent.com/winesapOS/winesapOS/stable/scripts/winesapos-upgrade.sh | sudo -E bash
curl https://raw.githubusercontent.com/winesapOS/winesapOS/main/scripts/winesapos-upgrade.sh | sudo -E bash
```
- winesapOS 3 to winesapOS 4:
- GUI = Launch the "winesapOS Upgrade" desktop shortcut.
- CLI:
```
curl https://raw.githubusercontent.com/winesapOS/winesapOS/stable/scripts/winesapos-upgrade.sh | sudo -E bash
curl https://raw.githubusercontent.com/winesapOS/winesapOS/main/scripts/winesapos-upgrade.sh | sudo -E bash
```
### Uninstall
@ -964,7 +964,7 @@ Here is how to upgrade winesapOS. Do **NOT** use "Applications (bauh)" for upgra
If desired, it is possible to remove winesapOS specific files and configuration and switch back to upstream Arch Linux using an uninstall script. It will not remove anything that is related to improved hardware compatibility.
```
curl https://raw.githubusercontent.com/winesapOS/winesapOS/stable/scripts/winesapos-uninstall.sh | sudo -E bash
curl https://raw.githubusercontent.com/winesapOS/winesapOS/main/scripts/winesapos-uninstall.sh | sudo -E bash
```
### Convert to winesapOS
@ -989,7 +989,7 @@ What it does NOT do:
Run this script to convert to winesapOS:
```
curl https://raw.githubusercontent.com/winesapOS/winesapOS/stable/scripts/winesapos-convert.sh | bash
curl https://raw.githubusercontent.com/winesapOS/winesapOS/main/scripts/winesapos-convert.sh | bash
```
## Tips

View file

@ -36,7 +36,7 @@ if [[ "${WINESAPOS_DISTRO_DETECTED}" == "arch" ]] || [[ "${WINESAPOS_DISTRO_DETE
echo "Arch Linux or Manjaro detected. winesapOS conversion will attempt to install all packages."
sudo pacman -S -y
"${CMD_PACMAN_INSTALL[@]}" base-devel flatpak git
curl --location https://raw.githubusercontent.com/winesapOS/winesapOS/stable/files/os-release-winesapos --output /usr/lib/os-release-winesapos
curl --location https://raw.githubusercontent.com/winesapOS/winesapOS/main/files/os-release-winesapos --output /usr/lib/os-release-winesapos
ln -s /usr/lib/os-release-winesapos /etc/os-release-winesapos
if [[ "${WINESAPOS_DISTRO_DETECTED}" == "arch" ]]; then