diff options
author | Stan Gurenkov <klausflex@gmail.com> | 2021-09-24 13:05:29 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-24 10:05:29 -0700 |
commit | 4493a05b74d8852222faa776d140233745114c53 (patch) | |
tree | a7f272534946d9f7098e57d5e022c7f74fe34ef4 /keyboards/signum/3_0/keymaps/default/readme.md | |
parent | 60b13d04cdf4b27f387be90d830dd196c38b1362 (diff) |
[Keyboard] refactor signum30 (#14527)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Stan Gurenkov <stan.gurenkov@docusign.com>
Diffstat (limited to 'keyboards/signum/3_0/keymaps/default/readme.md')
-rw-r--r-- | keyboards/signum/3_0/keymaps/default/readme.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/signum/3_0/keymaps/default/readme.md b/keyboards/signum/3_0/keymaps/default/readme.md new file mode 100644 index 0000000000..be8cc30e8a --- /dev/null +++ b/keyboards/signum/3_0/keymaps/default/readme.md @@ -0,0 +1,24 @@ +# Default layout + +Layout created by: [Jan Christoph Ebersbach](https://github.com/jceb) + +The `generate_km.py` file automatically generates `keymap.c` with +additional comments that visually represent the layout. + +This layout is maintained as I am using it. You can also use it as a +starting point to create your own layouts for the Signum 3.0 with +`km_template.txt` and `generate_km.py`. + +# Customization + +- Customize `layout.py` to your liking. + - Attention 1: keycodes are either translated into symbols and + function calls via the `translate()` function in `generate_km.py` + or via user-defined mappings in the dictionary `qmk_dict` in + `layout.py`. Especially the latter might require adjustment for + uncommon qmk features + - Attention 2: additional C functions need to be put into + `km_template.txt` + +Run `./generate_km.py` to regenerate `keymap.c` and the JSON keymap +definition that should be copied to `qmk_configurator/public/keymaps`. |