aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: c081265929d0ddb66dece0d0d76ff13dcd583ee9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
### qmk.me
this is a self-contained repository for my personal [qmk](https://github.com/qmk/qmk_firmware) userspace & keyboard code.

![keyboard](https://i.imgur.com/s0dN0JD.jpeg)

### building
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
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.

### 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.

![layout](img/layout.svg)