diff options
| author |  arisudesu | 2024-06-12 06:00:54 +0300 |
|---|---|---|
| committer |  GitHub | 2024-06-12 13:00:54 +1000 |
| commit | 0f10c50b4cf01d4dad4e9d19d1655207b37fb81e (patch) | |
| tree | 145f3bf7b2cb5e7dbb076206f1f7c29dbd133d90 | |
| parent | 7672002109b5856fc1b43df292bca4836fdb99d5 (diff) | |
| download | my-keymaps-0f10c50b4cf01d4dad4e9d19d1655207b37fb81e.tar.gz my-keymaps-0f10c50b4cf01d4dad4e9d19d1655207b37fb81e.zip | |
Add `qmk config user.overlay_dir` step to README.md (#23)
| -rw-r--r-- | README.md | 3 |
1 files changed, 2 insertions, 1 deletions
@@ -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 |