Repository navigation
Write a full README for users and developers - #3
Merged
Merged
Conversation
Covers what the tool is for, Phase 1 features, download and first run (UAC, SmartScreen), a short how-to, troubleshooting, roadmap, files it writes, and build/layout/CI notes. Adds a cropped CI screenshot of the main window. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015b2AspKNFwd3rzcGepsPMh
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015b2AspKNFwd3rzcGepsPMh
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 Simon · project thread
What changes for the user
Before: the README was a two-line placeholder.
After: the README explains what the tool is for, lists the Phase 1 features, walks through download and first run (UAC prompt, SmartScreen on the unsigned exe), gives a six-step how-to and a troubleshooting table, sets out the Phase 2 and 3 roadmap, says which files and firewall rule the app creates, and covers build commands, project layout, CI and contributing for developers. A cropped CI screenshot of the main window (dark mode) is added under
docs/images/.How
Every feature and file path was checked against the Phase 1 branch (#1). The README describes Phase 1 as in progress, so it stays accurate whether it merges before or after #1.
#1 also rewrites
README.md, so whichever PR merges second will hit a conflict on that one file. Resolve it by keeping this version, which includes everything #1's README says.Testing
🤖 Generated with Claude Code
https://claude.ai/code/session_015b2AspKNFwd3rzcGepsPMh
Generated by Claude Code