summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorglanchow <glanchow@gmail.com>2021-01-27 18:39:58 +0100
committerGitHub <noreply@github.com>2021-01-28 04:39:58 +1100
commit162842f16ee2e064f826712c3cd0c4d24445732e (patch)
tree6863496bcc30ece33f27d4acec96f40b02f9b3ce
parentc27f16158d3f9524bb2d608ef4918783e7551637 (diff)
[Docs] add qmk setup home parameter (#11451)
-rw-r--r--docs/newbs_getting_started.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
index 1c72911d92..3cb63e5692 100644
--- a/docs/newbs_getting_started.md
+++ b/docs/newbs_getting_started.md
@@ -168,6 +168,8 @@ Once that completes, re-run `qmk setup` to complete the setup and checks.
<!-- tabs:end -->
+?> The qmk home folder can be specified at setup with `qmk setup -H <path>`, and modified afterwards using the [cli configuration](cli_configuration.md?id=single-key-example) and the variable `user.qmk_home`. For all available options run `qmk setup --help`.
+
?> If you already know [how to use GitHub](getting_started_github.md), we recommend that you create your own fork and use `qmk setup <github_username>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message.
## 4. Test Your Build Environment