qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

commit 1a7f544e0df833f9709aaa724f9fd8b5c5c274de
parent 3e0b22af68da07bf2854ecde6b0f31f98fd027e2
Author: Jack Sangdahl <jack@pngu.org>
Date:   Fri, 21 Nov 2025 23:57:58 -0700

[CLI] Lint error on missing keyboard readme (#25814)


Diffstat:
Mlib/python/qmk/cli/lint.py | 4++++
1 file changed, 4 insertions(+), 0 deletions(-)

diff --git a/lib/python/qmk/cli/lint.py b/lib/python/qmk/cli/lint.py @@ -304,6 +304,10 @@ def keyboard_check(kb): # noqa C901 cli.log.error(f'{kb}: The file "{file}" should not exist!') ok = False + if not _get_readme_files(kb): + cli.log.error(f'{kb}: Is missing a readme.md file!') + ok = False + for file in _get_readme_files(kb): if _is_invalid_readme(file): cli.log.error(f'{kb}: The file "{file}" still contains template tokens!')