Skip to content
This repository was archived by the owner on Sep 30, 2025. It is now read-only.

Latest commit

 

History

67 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

qmk-comment-gen

Generates fancy layout comments for qmk keymaps

Requirements

  • Python 3.6+
  • Keymap starts on a new line. Example:
[_HOME] = LAYOUT(

KC_NO, etc...

How to use

  • run gen.py
  • open comment.txt

What's new?

  • added support for multiple layers
  • Better boxes
  • Clipboard support

Example

# Generate comments for the default planck keymap
python3 gen.py -i ../qmk_firmware/keyboards/planck/keymaps/default/
# Change the output file to planck.txt
python3 gen.py -i ../qmk_firmware/keyboards/planck/keymaps/default/ -o planck.txt

Featured Fork

https://github.com/sjungq/qmk-comment-gen/tree/sjung

About

Generates fancy layout comments from qmk keymap.c

Topics

Resources

Stars

33 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages