From fc6c01fd6941ec795710d66ead9e17d5dfbaa19d Mon Sep 17 00:00:00 2001
From: Kurtis Lew <kurtis.a.lew@gmail.com>
Date: Fri, 9 Oct 2020 20:56:52 -0700
Subject: [PATCH] -DZMK_CONFIG Documentation (#255)

feat(docs): `-DZMK_CONFIG` Documentation
---
 docs/docs/dev-build.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/docs/dev-build.md b/docs/docs/dev-build.md
index 816468e2..83ed8cb9 100644
--- a/docs/docs/dev-build.md
+++ b/docs/docs/dev-build.md
@@ -84,6 +84,19 @@ west build -d build/right -b nice_nano -- -DSHIELD=kyria_right
 ```
 This produces `left` and `right` subfolders under the `build` directory and two separate .uf2 files. For future work on a specific half, use the `-d` parameter again to ensure you are building into the correct location.
 
+### Building from `zmk-config` Folder
+
+Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](user-setup#github-repo) by adding 
+`-DZMK_CONFIG="C:/the/absolute/path/config"` to your `west build` command. **Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.**
+
+
+For instance, building kyria firmware from a user `myUser`'s `zmk-config` folder on Windows 10 may look something like this:
+
+```
+west build -b nice_nano -- -DSHIELD=kyria_left -DZMK_CONFIG="C:/Users/myUser/Documents/Github/zmk-config/config"
+```
+
+
 ## Flashing
 
 Once built, the previously supplied parameters will be remembered so you can run the following to flash your