docs: rewrite README and docs/ (includes a trademark question needing your decision) - #114
Merged
Conversation
… your decision) Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
…hanged The licence file stays as it is. The README now carries a prominent warning that the bundled Python logo and Python Powered badges are PSF copyright and trademarks, governed by the PSF Trademark Usage Policy rather than the GPL, and that altering or redistributing altered marks is not permitted. The documentation index, FAQ, and roadmap record the same position as decided rather than open. 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 three defects — the first of which needs a decision from you.The licence position on the images.
LICENSE.mdis GPL v3 and the README said "This project is licensed under the GNU General Public License" with no carve-out. The three bundled GIFs are the Python logo and the two "Python Powered" badges — PSF trademarks, governed by the PSF Trademark Usage Policy, not the author's to place under GPL. The GPL grants recipients the right to modify and redistribute what it covers, which is exactly what a trademark policy restricts.This is the one repository in the sweep whose entire content is third-party trademarked artwork, so it is not a corner case. The README now states the split — code GPL, images PSF — and the finding records three options (an explicit split in
LICENSE.md, aNOTICE/CONTENT_LICENSE.md, or replacing the bundled marks with original artwork and linking the official badges). I changed no licence file; that is yours to decide.README — the
/blob/-free screenshots now come from the.githubicons repo,## Changelogand## You may also likeare gone, and the credits table is untouched.docs/restructured.CUSTOMIZATION.mdandUSAGE.mdremoved, their content folded intoconfiguration.mdandquickstart.md.docs/images/removed.docs/legal/PRIVACY.mdandTERMS.mdlowercased to match the docs contract (README links updated). New: index,quickstart,installation,configuration,architecture,api,development,faq,troubleshooting,roadmap.Also recorded:
str(files(...))assumes a filesystem path, so_load_imagefails for a zipimported package. It is the last step of theimportlib.resourcesreasoning left incomplete, and it fails in exactly the packaging scenario a widget library gets swept into — someone bundling their Tkinter app.as_file()is the fix.Worth noting approvingly, and documented as such in
architecture.md: resources are resolved throughimportlib.resourcesrather than a path relative to__file__or the CWD, and each widget binds itsPhotoImagetoself._image. Those two are the difference between this package and the two sibling Tkinter repos in this batch, both of which get one or the other wrong and fail silently for it.Documentation only — no source, image, or licence-file changes.