Repository navigation
Add license, README and lint tooling - #2
Merged
Merged
Conversation
Adds project documentation and the same formatting/lint setup used in toon-esphomeair: - LICENSE: MIT for this fork, with a notice that upstream ToonSoftwareCollective/tscClock declares no license of its own, so the grant cannot cover the code inherited from it. - README.md: what the tile shows, install, both settings screens, how the Waze fetch works, differences from upstream and the versioning rationale for 1.1.0. - pre-commit + PR Lint workflow: prettier on JSON/YAML/Markdown, pyside6-qmlformat/qmllint on QML, plus whitespace and line-ending hooks. - .gitattributes normalises to LF; .gitignore/.prettierignore exclude .claude/. version.txt and Changelog.txt pick up the trailing-newline and trailing-whitespace fixes from the new hooks; no content change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
luukvisser
changed the base branch from
claude/align-time-date-block-HPN3c
to
main
August 6, 2026 14:17
This was referenced Aug 6, 2026
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.
Targets
main, now that #1 is merged. The diff is exactly the ten files below.License
Upstream
ToonSoftwareCollective/tscClockpublishes no license file, so its code is technically all-rights-reserved. TheLICENSEhere is MIT covering this fork's changes, with an explicit notice that the grant cannot extend to the inherited upstream code. Three sibling repos in that org (nlalert, toonmqtt, ToonRooter) are MIT — worth asking TSC to do the same for tscClock, which would make this clean.README
Covers both tile layouts, install, both settings screens with default tables, how the Waze fetch and refresh logic works, differences from upstream, and known limitations (undocumented Waze endpoint, coordinates leaving the device, missing
drawables/clock.svg, Dutch-only UI).Versioning
Checked against upstream: this fork branched from upstream HEAD (
af304ec, Dec 2022) at version 1.0.1, and upstream has not moved since. Everything added since — centred layout, day-on-date row, Waze travel times — is additive and backwards compatible; absent settings keys fall back to defaults, nothing was removed. 1.1.0 is the correct semver bump. The README notes the one caveat: sharing upstream's numbering line means a hypothetical upstream 1.1.0 would be indistinguishable.Tooling
Ported verbatim from
luukvisser/toon-esphomeair:.pre-commit-config.yaml,.prettierrc.json,.gitattributesand.github/workflows/pr-lint.yml. Added.prettierignore(the workflow already referenced it) and.gitignore, both excluding.claude/.Verified locally: the exact prettier command from the workflow passes, and the non-QML pre-commit hooks pass. They fixed a trailing space in
Changelog.txtand a missing final newline inversion.txt—version.txtis now1.1.0\n, matching toon-esphomeair, which the ToonStore handles fine.The QML files are not reformatted in this PR.
qmlformatwould rewrite all four substantially, and that diff can only be validated on a real Toon, so it belongs in its own change. CI only checks QML files touched by a PR, so this one passes as-is; the first future PR touching a.qmlwill need it formatted.🤖 Generated with Claude Code