summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristoph Cullmann <christoph@cullmann.io>2024-09-22 18:21:56 +0200
committerChristoph Cullmann <christoph@cullmann.io>2024-09-22 18:21:56 +0200
commitfaa0a81b832ce19b4471c3c8b960bdb95a047597 (patch)
treebf979991caf90a55489f686cc755790a44f46994 /README.md
parentfdb81678f8edfe198548062417d25125dae1e7f9 (diff)
use qmk userspac as described here: https://docs.qmk.fm/newbs_external_userspace
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 34a6c16..6e649c8 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,10 @@ Layout with 42 keys based on Miryoku, using Dhorf as base layer:
# How to use
+This repository is a valid QMK external userspace as documented here:
+
+ https://docs.qmk.fm/newbs_external_userspace
+
You need to have a locally setup QMK and use this repo as overlay:
qmk config user.overlay_dir="/home/cullmann/data/qmk/christoph-cullmann"