From 700f3e514b4610b7ac7862229d06298ff72930c0 Mon Sep 17 00:00:00 2001 From: Rick Peters Date: Fri, 25 Sep 2026 08:18:40 +0200 Subject: [PATCH] docs: README links to the files it mentions; drop setup-gamescope-boot.sh The release no longer publishes the bundle under its pre-0.9.0 name. --- .github/workflows/bundle.yml | 8 ++------ CHANGELOG.md | 5 ++++- README.md | 18 +++++++++++++----- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/.github/workflows/bundle.yml b/.github/workflows/bundle.yml index 6e04be6..5cc28d2 100644 --- a/.github/workflows/bundle.yml +++ b/.github/workflows/bundle.yml @@ -5,8 +5,6 @@ # release are moved to it, so both of these always get the newest version: # curl -fsSL https://github.com/theupriser/steamify-cachyos/releases/latest/download/steamify.sh | bash # curl -fsSL https://github.com/theupriser/steamify-cachyos/releases/download/latest/steamify.sh | bash -# The bundle is also published as setup-gamescope-boot.sh, its name before -# 0.9.0, so older install commands keep working. # Pull requests only build and check it, and warn when VERSION is already released. name: Single-file build @@ -30,8 +28,6 @@ jobs: - name: Build run: | .github/tools/bundle.sh dist/steamify.sh - # Old name (before 0.9.0), for older install commands and links. - cp dist/steamify.sh dist/setup-gamescope-boot.sh - name: Check run: | @@ -77,7 +73,7 @@ jobs: ## Changes in v$VERSION $changes" - gh release create "v$VERSION" dist/steamify.sh dist/setup-gamescope-boot.sh assets/steam-gaming-settings.svg \ + gh release create "v$VERSION" dist/steamify.sh assets/steam-gaming-settings.svg \ --target "$GITHUB_SHA" --title "Steamify CachyOS v$VERSION" --notes "$notes" --latest # "latest" follows the newest version tag, for the older install URL @@ -90,4 +86,4 @@ jobs: else gh release create latest --title "Steamify CachyOS - latest (v$VERSION)" --notes "$latest_notes" --latest=false fi - gh release upload latest dist/steamify.sh dist/setup-gamescope-boot.sh assets/steam-gaming-settings.svg --clobber + gh release upload latest dist/steamify.sh assets/steam-gaming-settings.svg --clobber diff --git a/CHANGELOG.md b/CHANGELOG.md index b112ec0..d8bfcde 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,10 @@ one per merged pull request. pinned kernel keeps matching headers. - The BIOS item moves down one (9 on a Steam Machine). - **docs: Shorter README, with a Steam Machine section** - - How it works moved to `TECHNICAL.md`, problems to `TROUBLESHOOTING.md`. + - How it works moved to `TECHNICAL.md`, problems to `TROUBLESHOOTING.md`; + the README links to them and to the files it mentions. +- **chore: No more `setup-gamescope-boot.sh` release asset** + - Only `steamify.sh` is published; the old name from before 0.9.0 is gone. ## 0.10.0 - 2026-09-24 diff --git a/README.md b/README.md index b63907a..4ea4485 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,12 @@ Steam Machine. - **Boot into: gamescope / desktop** - where the PC starts. Gaming mode is the default. 2. **SteamOS theme** - the Vapor look of SteamOS for the desktop, with - **Add to Steam** in right-click menus. + **Add to Steam** in right-click menus + ([details](TECHNICAL.md#steamos-desktop-look)). 3. **Steam Deck/Machine icons** - Steam Deck button icons in gaming mode. 4. **Single user mode** - like SteamOS: never a login or lock screen. Typing a - password with a controller is no fun. + password with a controller is no fun + ([details](TECHNICAL.md#single-user-mode-sddm-no-locking)). 5. **Steamify shortcut** - an icon on the desktop and in the launcher that opens the newest Steamify, so you don't need the install command again. @@ -34,9 +36,13 @@ On a Valve Steam Machine the menu has two more items: button puts it to sleep like a console. - **Pin the kernel to 7.1.6-1** - on by default: with newer CachyOS kernels the Steam Machine reboots instead of shutting down. Untick it once CachyOS - fixes that. + fixes that. The kernel comes from its own + [release](https://github.com/theupriser/steamify-cachyos/releases/tag/kernel-7.1.6-1), + checked against CachyOS's signature + ([details](TECHNICAL.md#kernel-pin-steam-machine)). - **Update BIOS** - installs Valve's newest Steam Machine BIOS. Never ticked - by default, at your own risk, and only after two warnings. + by default, at your own risk, and only after two warnings + ([details](TECHNICAL.md#bios-updates-steam-machine)). ## Requirements @@ -52,7 +58,8 @@ curl -fsSL https://github.com/theupriser/steamify-cachyos/releases/latest/downlo ``` Prefer to look at the script first? Clone the repository and run -`./steamify.sh` (keep the whole folder: it needs `lib/`). +[`./steamify.sh`](steamify.sh) (keep the whole folder: it needs +[`lib/`](lib/)). You'll see a checklist: @@ -102,6 +109,7 @@ sudo /usr/lib/steamos/steam-set-session plasma.desktop && sudo systemctl restart More in [TROUBLESHOOTING.md](TROUBLESHOOTING.md). How it all works: [TECHNICAL.md](TECHNICAL.md). Changes per version: [CHANGELOG.md](CHANGELOG.md). +Contributing (or an AI agent)? Read [AGENTS.md](AGENTS.md). ## License