Repository navigation
Rewrite the README for frame-beta-3 and the update modes - #13
Merged
Merged
Conversation
Restructure the README around what a player does: choose where to build (PC or the Frame), install, update, play, then settings, controls, known issues and troubleshooting. Building on a server and by hand move under "Other ways to build", and the upstream and credits notes are merged into "What comes from where" and a short Credits section that points at CREDITS.md. Updating now shows the curl form of --update, which works without a local copy of the script; the in-game Updates tab; and the one full install needed when coming from frame-beta-2. Manual steps use the frame-beta-3 tag, the install options are a table, and the Troubleshooting section covers in-game update failures. Links to the old "The Android flavour" section now point at "How it works". Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Axv1Y43Lu5a5rSSLUyU5BB
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Mitch · project thread
Before: the README had grown by patches. Updating showed
Launcher/steam-frame-install.sh --update, which needs a local copy of the script. Building on the Frame was buried under "Other ways to build". Upstream, credits and related-project notes were scattered across several sections, the AI usage note pointed at an FAQ entry that doesn't exist, and the by-hand steps used old release tags.After: the README follows what a player does. It starts with where to build (PC or the Frame, compared in a table), then install, update and play, then settings, controls, known issues and troubleshooting. Updating covers the
curl … | bash -s -- --updateform, the in-game Updates tab for--frame localinstalls, and the one full install needed when coming from frame-beta-2. Server and by-hand builds sit under "Other ways to build", and credits link to CREDITS.md.How: a rewrite of README.md, with every command, path and option checked against
Launcher/steam-frame-install.shand every in-page anchor checked. Links in OPENXR.md, docs/quest-port.md and android/README.md that pointed at the old "The Android flavour" section now point at "How it works".🤖 Generated with Claude Code
https://claude.ai/code/session_01Axv1Y43Lu5a5rSSLUyU5BB