bigtreetech / bigtreetech/PandaTouch_IDF
README shows an MIT badge but the repository contains no LICENSE file
- Dominant language
- C
- Stars
- 12
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Hi, and thanks for publishing this component — the LCD, GT911 and USB MSC glue
saved us a lot of bring-up work.
There is a licensing gap that makes the component hard to build on, and I think
it is unintentional:
- `README.md` displays a `License: MIT` badge, and the badge links to `LICENSE`.
- There is no `LICENSE` file in the repository.
- GitHub's license API returns 404 for this repository, so no license is
detected in the repository metadata either.
- The README text itself reads "provided under the MIT License (assumed)".
Under default copyright law, code published without a license is "all rights
reserved": GitHub's Terms of Service let people view and fork it on the
platform, but grant no right to redistribute it or to ship it inside a
derivative work. So despite the badge, downstream projects cannot safely vendor
this component — and several already do, on the strength of the badge alone
(for instance `nomadsgalaxy/Prusa-Connect-Touch`, whose NOTICE file lists this
component as "BigTreeTech, MIT").
Would you consider adding the MIT license text as a `LICENSE` file at the
repository root, with the appropriate copyright line? That single file would
make the badge accurate, and let the component be used the way the badge
already suggests it can be.
Happy to open a PR with the standard MIT text if that is easier — you would
just need to confirm the copyright holder and year.
For context on what the component enabled: we used it to bring up a BIGTREETECH
K-Touch (the 5-inch model), and were able to confirm that the Panda Touch
7-inch pinout and timings work on it unchanged, display and GT911 touch alike.
That did not seem to be documented publicly anywhere. Happy to share the
details if they are useful to you or to others.
Contributor guide
Research direction
Start with README.md and verify that its MIT badge links to the missing root-level LICENSE file. Add the standard MIT license text after the copyright holder and year are confirmed, then check that the badge link resolves and the README wording is accurate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100