Skip to content

Commit 0f10c50

Browse files
authored
Add qmk config user.overlay_dir step to README.md (qmk#23)
1 parent 7672002 commit 0f10c50

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This is a template repository which allows for an external set of QMK keymaps to
77
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
88
1. Fork this repository
99
1. Clone your fork to your local machine
10+
1. Enable userspace in QMK config using `qmk config user.overlay_dir="$(realpath qmk_userspace)"`
1011
1. Add a new keymap for your board using `qmk new-keymap`
1112
* 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>`
1213
* 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
5556

5657
1. (First time only) `git submodule add https://github.com/qmk/qmk_firmware.git`
5758
1. (To update) `git submodule update --init --recursive`
58-
1. Commit your changes to your userspace repository
59+
1. Commit your changes to your userspace repository

0 commit comments

Comments
 (0)