Docs: README for GUI-first exe + chromeless in-window report - #3
Merged
Merged
Conversation
…ow report Document the GUI-first behavior and chromeless report window: - launching with no arguments opens the Tkinter desktop GUI; a path or any flag runs the CLI scanner as before - after a GUI scan the interactive HTML report opens automatically in a chromeless Edge/Chrome --app window (falls back to the default browser) - double-clicking the standalone exe opens the desktop GUI - usage/options table notes that no-arguments opens the GUI Docs-only change (README is this project's user manual; there is no docs/). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Brings the README (this project's user manual — there is no
docs/) up to date with the current state of the code, so the docs are correct before the next release tag is cut.Documents the changes that the README didn't yet reflect:
--appwindow (falls back to the default browser if neither is installed).The earlier exe-packaging surface (embedded icon + version resource, optional Inno Setup installer, GitHub Actions release workflow) was already documented and is verified still accurate.
Verified line-by-line against
src/storageanalyzer/cli.py(main()dispatch),src/storageanalyzer/gui.py(open_report_window/find_app_browser/app_window_argv/_maybe_hide_console), andpyproject.toml.Scope
Docs-only. Touches
README.mdonly — no planning/PLAN_MAIN/phase files, no TODO, no code.v*release tag is cut. The release tag should be cut from amainwhose docs already match the shipped behavior.src/storageanalyzer/cli.py,gui.py,storageanalyzer.spec,tests/test_gui.py, newtests/test_cli.py) — it is not onmain. This PR documents that behavior but, being docs-only, does not carry the code. That code must be committed/merged before or together with this PR, otherwisemain's README would describe behaviormain's code doesn't yet have. Coordinate the two before tagging.🤖 Generated with Claude Code