Repository navigation
docs: clarify installation and Raycast setup - #18
Merged
Merged
Conversation
… extension setup Docs-only. README and raycast-extension/README now describe a Homebrew install -> config -> Accessibility permission -> service start flow, clarify that modifier remaps are reapplied at startup and after wake and cleaned up on normal shutdown, and point readers at the Raycast Store submission status (pending review) with local-install guidance from the submission fork branch while approval is pending. Adds a CHANGELOG [Unreleased] Documentation entry; no version tag or release claim is made.
The earlier commit added a Keep a Changelog [Unreleased] section to CHANGELOG.md, but scripts/version-sync.sh requires the top entry to match the canonical 0.1.1 version and rejects the literal string "[Unreleased]". Per the docs-only scope of this PR and the instruction not to claim a new release, drop the CHANGELOG change. The proposed entry text is preserved verbatim in the PR description for the maintainer to add as part of the next release PR.
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
1 participant
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.
Docs-only change (no code, no tags, no release claim, no CHANGELOG mutation).
Included files (vs
origin/main):README.md(+141 / -106)raycast-extension/README.md(+65 / -20)What changed
## Installblock with a Homebrew quick start that separates install, config, Accessibility permission, service start, and the optional Raycast UI; add Usage, Troubleshooting, Uninstall, and Upgrade sections; clarify that[[modifier_remap]]mappings are reapplied at startup and after wake and are cleaned up on normal shutdown; correct the sample-config commentary.npm run devdoes not stop the remapping daemon.Notes for reviewers
brew services stop switcheroo) beforebrew uninstall switcheroo; for the standalone installer use./uninstall.shaftercargo build --release --locked. Do not run both providers at once.[[modifier_remap]]mappings are not inherently persistent across reboot — the login service reapplies them and normal shutdown cleans up owned entries.About the CHANGELOG
This PR deliberately does not edit
CHANGELOG.md.scripts/version-sync.sh(run by CI's "Version sync" job) requires the top## [X.Y.Z]entry to match the canonical Cargo.toml version (0.1.1); an## [Unreleased]heading at the top causes that check to fail. Per the docs-only scope and the instruction not to publish a new version, the proposed entry is included below for the maintainer to fold into the next release PR:No tag, no release, no merge performed by this PR.