qmk_firmware
qmk_firmware copied to clipboard
[QP CLI] Single-step QFF generation.
Description
The conversion has 2 steps
- Font (
.ttf
) -> Image (.png
) - Image (
.png
) -> QMK (.qff
)
Currently, users are forced to go though it via invoking 2 different commands
- Slower and less intuitive
- Prone to issues (mismatch arguments, eg glyphs, between them)
- Produces an extra artifact (intermediate png)
- Most users will never edit the image anyway
Thus, this PR adds a 3rd command that does both things at once 🤓
On the down side, it adds a small breaking change due to flags renaming to prevent collision with shorthand forms (format and file)
NOTE: Depends on #20101
Types of Changes
- [ ] Core
- [ ] Bugfix
- [X] New feature
- [X] Enhancement/optimization
- [ ] Keyboard (addition or update)
- [ ] Keymap/layout/userspace (addition or update)
- [ ] Documentation
Issues Fixed or Closed by This PR
Checklist
- [X] My code follows the code style of this project: C, Python
- [X] I have read the PR Checklist document and have made the appropriate changes.
- [X] My change requires a change to the documentation.
- [X] I have updated the documentation accordingly.
- [X] I have read the CONTRIBUTING document.
- [ ] I have added tests to cover my changes.
- [X] I have tested the changes and verified that they work and don't break anything (as well as I can manage).
Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug
, awaiting review
, breaking_change
, in progress
, or on hold
to prevent the issue from being re-flagged.
This is not stale, may it get an "awaiting review" label? Thx!!