From 0f10c50b4cf01d4dad4e9d19d1655207b37fb81e Mon Sep 17 00:00:00 2001
From: arisudesu <arisudesu@yandex.ru>
Date: Wed, 12 Jun 2024 06:00:54 +0300
Subject: [PATCH 1/3] Add `qmk config user.overlay_dir` step to README.md (#23)

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 72b7d82c..9a96cbe3 100644
--- 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

From e6f22f98b2b1b0c00d6eefa205d8a09e29d3f04f Mon Sep 17 00:00:00 2001
From: Chad Skeeters <chad.skeeters@gmail.com>
Date: Thu, 29 Aug 2024 21:27:51 -0500
Subject: [PATCH 2/3] Removes duplicated word *with* in README.md (#29)

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9a96cbe3..25208997 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ This is a template repository which allows for an external set of QMK keymaps to
 1. Add your keymap(s) to the build by running `qmk userspace-add -kb <your_keyboard> -km <your_keymap>`
     * This will automatically update your `qmk.json` file
     * Corresponding `qmk userspace-remove -kb <your_keyboard> -km <your_keymap>` will delete it
-    * Listing the build targets can be done with with `qmk userspace-list`
+    * Listing the build targets can be done with `qmk userspace-list`
 1. Commit your changes
 
 ## Howto build with GitHub

From 35edec2998d4ffd2d005966537d8be431795a3aa Mon Sep 17 00:00:00 2001
From: Sergey Vlasov <sigprof@gmail.com>
Date: Thu, 5 Sep 2024 11:51:35 +0300
Subject: [PATCH 3/3] Add clangd-related entries to `.gitignore` (#31)

This is needed to support VS Code with clangd for userspace keymaps (in
this case `compile_commands.json` and `.cache/clangd` are located in the
`qmk_userspace` working copy).
---
 .gitignore | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/.gitignore b/.gitignore
index ec5cfa2b..800a4e2c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,8 @@
 *.hex
 *.bin
 *.uf2
+
+# clangd
+compile_commands.json
+.clangd/
+.cache/