diff options
author | Jack Sangdahl <[email protected]> | 2025-06-28 17:34:47 -0600 |
---|---|---|
committer | Jack Sangdahl <[email protected]> | 2025-06-28 17:34:47 -0600 |
commit | 2ce46c6004c655e9959f5d9326e07f32d70527bc (patch) | |
tree | fd1b6fbb4d0660afd66ba1ef814beb8f013e5f3f /readme.md | |
parent | 118f17bae7ad40b79548a3a33a90adfcaba12175 (diff) | |
download | qmk_me-2ce46c6004c655e9959f5d9326e07f32d70527bc.tar.gz qmk_me-2ce46c6004c655e9959f5d9326e07f32d70527bc.zip |
Add _keymap callbacks
Better guarding for various feature-specific code
Improve makefile logic
Small readme fixes
Remove keyboards from shell script
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 18 |
1 files changed, 8 insertions, 10 deletions
@@ -1,23 +1,21 @@ -### qmk.me -this is a self-contained repository for my personal [qmk](https://github.com/qmk/qmk_firmware) userspace & keyboard code. +## qmk.me +This is a self-contained repository for my personal [QMK](https://github.com/qmk/qmk_firmware) userspace & keyboard code.  ### building -symlinks are used to compile this code in a proper `qmk_firmware` repository. +Symlinks are used to compile this code in a proper `qmk_firmware` repository. eg. ```shell -ln -s ~/qmk.me/jack ~/qmk_firmware/users/jack -ln -s ~/qmk.me/keyboards/relic ~/qmk_firmware/keyboards/relic -echo "users/jack\nkeyboards/relic" >> ~/qmk_firmware/.git/info/exclude +ln -s qmk.me/jack qmk_firmware/users/jack +ln -s qmk.me/keyboards/relic qmk_firmware/keyboards/relic +echo "users/jack\nkeyboards/relic" >> qmk_firmware/.git/info/exclude qmk compile -kb relic -km jack ``` -the official [userspace feature](https://docs.qmk.fm/newbs_external_userspace) -is not used as this repository contains personal keyboards, which are not supported. +The official external [userspace feature](https://docs.qmk.fm/newbs_external_userspace) is not used as this repository contains personal keyboards, which are not supported. ### layout -a simple 34-key layout that makes use of 2 (primary) layers, home-row mods, & combos for many symbols. -mostly used in sway, vim (c, python), & other generic computing tasks. +A simple 34-key layout that makes use of 2 (primary) layers, home-row mods, & combos for many symbols. Mostly used in Sway, Vim (C, Python), & other generic computing tasks.  |