docs: clarify Runtime Viewer installation and source discovery - #92
Open
mvanhorn wants to merge 1 commit into
Open
docs: clarify Runtime Viewer installation and source discovery#92mvanhorn wants to merge 1 commit into
mvanhorn wants to merge 1 commit into
Conversation
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.
Issue #83 reports an empty initial experience after installing an unofficial Homebrew cask, registering the helper service, and expecting applications to appear as connection targets. The maintainer clarified that Runtime Viewer is not published through Homebrew and directed users to GitHub Releases, but the README's Getting Started section currently begins with helper registration and never states how to install the main app. It also does not clearly distinguish the bundled local runtime source, explicitly attached processes, and other Runtime Viewer instances discovered over Bonjour. This documentation gap makes helper installation look like the step that should populate a list of applications.
Summary
Add a concise installation subsection at the start of
README.md's Getting Started section that identifies GitHub Releases as the official binary source, tells users to install the macOS app from the release archive, and explicitly notes that the project does not publish a Homebrew cask. Keep the existing helper instructions, but clarify that helper registration enables inter-process communication and injection rather than installing the main app or automatically creating connection targets. Add a short first-use explanation of the three supported entry paths already represented in the README and app: browse the local runtime/framework directory, use Attach Process when its SIP prerequisite is met, or select another Runtime Viewer instance discovered on the local network.Test plan
Fixes #83