]> git.otsuka.systems Git - qmk-keymaps/commitdiff
Add `qmk config user.overlay_dir` step to README.md (#23)
authorarisudesu <arisudesu@yandex.ru>
Wed, 12 Jun 2024 03:00:54 +0000 (06:00 +0300)
committerGitHub <noreply@github.com>
Wed, 12 Jun 2024 03:00:54 +0000 (13:00 +1000)
README.md

index 72b7d82c8b2f47f05227fc21511f5418719d4f07..9a96cbe352dad3a5f4248eef7ee17630e0de1b70 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ This is a template repository which allows for an external set of QMK keymaps to
 1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
 1. Fork this repository
 1. Clone your fork to your local machine
+1. Enable userspace in QMK config using `qmk config user.overlay_dir="$(realpath qmk_userspace)"`
 1. Add a new keymap for your board using `qmk new-keymap`
     * This will create a new keymap in the `keyboards` directory, in the same location that would normally be used in the main QMK repository. For example, if you wanted to add a keymap for the Planck, it will be created in `keyboards/planck/keymaps/<your keymap name>`
     * You can also create a new keymap using `qmk new-keymap -kb <your_keyboard> -km <your_keymap>`
@@ -55,4 +56,4 @@ This can also be used to control which fork is used, though only upstream `qmk_f
 
 1. (First time only) `git submodule add https://github.com/qmk/qmk_firmware.git`
 1. (To update) `git submodule update --init --recursive`
-1. Commit your changes to your userspace repository
\ No newline at end of file
+1. Commit your changes to your userspace repository