mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-18 15:43:23 +00:00
05be1de1aa
* FORK! * WIP - just how i like it * empty * more movement * mouse keys * more vimminess * append/insert shift * WIP - vim macros * blocked out layer below in cmd mode. also, about to restart my cmd approach. * WIP - new vim layer ripoff of the ergodox one, but rewritten as a state machine. * debugged some, got key repeat working * moooar coverage * moooar coverage * regular vis mode * basically done with basics. * some refactoring - common movement sequences into helper function - added some rgb controls * modkey passthru feature * stdized on cmd-left/right instead of ctrl-a/e sadly. as there's no reliable shift-ctrl-e * indicator lights * moved vim layer into userspace * cleaned up some yanking edge cases * docs and some tweaks to layerescapes * updated/added license strings * updated comments * moved config changes to keymap * spurious changes removed
25 lines
866 B
Markdown
25 lines
866 B
Markdown
# How to add your own keymap
|
|
|
|
Folders can be named however you'd like (will be approved upon merging), or should follow the format with a preceding `_`:
|
|
|
|
_[ISO 3166-1 alpha-2 code*]_[layout variant]_[layout name/author]
|
|
|
|
\* See full list: https://en.wikipedia.org/wiki/ISO_3166-1#Officially_assigned_code_elements
|
|
|
|
and contain the following files:
|
|
|
|
* `keymap.c`
|
|
* `readme.md` *recommended*
|
|
* `config.h` *optional*, found automatically when compiling
|
|
* `Makefile` *optional*, found automatically when compling
|
|
|
|
When adding your keymap to this list, keep it organised alphabetically (select list, edit->sort lines), and use this format:
|
|
|
|
* **folder_name** description
|
|
|
|
# List of keymaps
|
|
- **default** default layout from KBDFans
|
|
- **mason**
|
|
- **planck** Planck default layout
|
|
- **xtonhasvim** A Planck-like layout with a few tweaks and a vim emulation layer.
|