docs: rewrite README and docs/ — records that the program cannot start - #117
Open
willtheorangeguy wants to merge 2 commits into
Open
docs: rewrite README and docs/ — records that the program cannot start#117willtheorangeguy wants to merge 2 commits into
willtheorangeguy wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
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
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.
Rewrites the README, restructures
docs/, and records six defects.ProgramVer does not currently run. Three files the code opens are absent from the repository:
ProgramVer()imgs/dfdlogo.gifMANIFEST.inlists itopenLicense()LICENSE.txtLICENSE.mdopenEULA()EULA.txtThe first raises
TclErrorbefore any widget is packed, so there is no window at all — viapython main.py, theprogramverconsole 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.openand every Tk widget, andtest_get_resource_pathasserts only that the returned string ends withdfdlogo.gif— never that it resolves. So "100% coverage of the main module" is true and says nothing about whether the program works.docs/testing.mdsets 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.githubicons repo. Several How To Use links omitted/blob/entirely and 404'd.## Changelogand## You may also likeare gone; the credits table is untouched.docs/restructured.TESTING.md→testing.md, rewritten around what the suite does not check.CUSTOMIZATION.mdremoved and replaced byconfiguration.md— the old one located each editable string by line number ("Line 11", "Line 40"), and those no longer matchmain.py, so following them edits the wrong string and leaves the window unchanged.USAGE.mdremoved (it told you to double-clicksend.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.mdis 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.pyandsetup.cfgdeclareimgs/as the package root (package_dir={"": "imgs"},find_packages(where="imgs")) where there are no Python packages, so onlypy_modules=["main"]ships anything and a real package added later would be silently excluded; and the README told readers to copyProgramVer.py, which does not exist.Documentation only — no source, asset, or packaging changes. Restoring
imgs/dfdlogo.gifis the smallest change that turns this back into a working program.