Skip to content

docs: rewrite README and docs/ — records that the program cannot start - #117

Open
willtheorangeguy wants to merge 2 commits into
masterfrom
docs/content
Open

docs: rewrite README and docs/ — records that the program cannot start#117
willtheorangeguy wants to merge 2 commits into
masterfrom
docs/content

Conversation

@willtheorangeguy

Copy link
Copy Markdown
Owner

Rewrites the README, restructures docs/, and records six defects.

ProgramVer does not currently run. Three files the code opens are absent from the repository:

Wanted by File Present
ProgramVer() imgs/dfdlogo.gif No — though MANIFEST.in lists it
openLicense() LICENSE.txt No — the repo has LICENSE.md
openEULA() EULA.txt No

The first raises TclError before any widget is packed, so there is no window at all — via python main.py, the programver console script, the PyInstaller build, or copying the module into another project. The README now opens with a Status section saying so.

CI is green throughout, which is the third finding: all 14 tests patch builtins.open and every Tk widget, and test_get_resource_path asserts only that the returned string ends with dfdlogo.gif — never that it resolves. So "100% coverage of the main module" is true and says nothing about whether the program works. docs/testing.md sets this out, with the four-line resource-existence test that would have caught all three.

README — 121 lines. The logo used a /blob/ URL (HTML, not image bytes) so it was broken everywhere; both images now come from the .github icons repo. Several How To Use links omitted /blob/ entirely and 404'd. ## Changelog and ## You may also like are gone; the credits table is untouched.

docs/ restructured. TESTING.mdtesting.md, rewritten around what the suite does not check. CUSTOMIZATION.md removed and replaced by configuration.md — the old one located each editable string by line number ("Line 11", "Line 40"), and those no longer match main.py, so following them edits the wrong string and leaves the window unchanged. USAGE.md removed (it told you to double-click send.exe, from some other project). docs/images/ removed. New: index, quickstart, installation, configuration, architecture, development, faq, troubleshooting, roadmap.

Also recorded: the window displays a GPL v3 notice for "Dog Face Development Co." dated 2024, while LICENSE.md is MIT © 2026 willtheorangeguy — placeholder text by design (each label is marked # change as needed), but this is a tool whose sole purpose is displaying accurate licence information, and its default output is the wrong licence, holder, and year; setup.py and setup.cfg declare imgs/ as the package root (package_dir={"": "imgs"}, find_packages(where="imgs")) where there are no Python packages, so only py_modules=["main"] ships anything and a real package added later would be silently excluded; and the README told readers to copy ProgramVer.py, which does not exist.

Documentation only — no source, asset, or packaging changes. Restoring imgs/dfdlogo.gif is the smallest change that turns this back into a working program.

willtheorangeguy and others added 2 commits August 18, 2026 15:00
The rewrite replaced the Windows credit with PyInstaller. The credits table
is house boilerplate and should carry through unchanged.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant