diff options
| author | Drashna Jaelre <drashna@live.com> | 2019-03-18 22:22:33 +0100 |
|---|---|---|
| committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-03-18 22:22:33 +0100 |
| commit | 161d469f2c9cf0ddf7aa5907eb2329d6df1ede85 (patch) | |
| tree | 035abc6e41e90f1ae2d2ec39483f94d0355284bc | |
| parent | c534a4c775098f2b6cc8e7f36d35cf642f4323a5 (diff) | |
| download | qmk_firmware-161d469f2c9cf0ddf7aa5907eb2329d6df1ede85.tar.gz qmk_firmware-161d469f2c9cf0ddf7aa5907eb2329d6df1ede85.tar.xz | |
[Docs] Recursively clone qmk_firmware repo (#5378)
* Recursively clone qmk_firmware repo
Specifically, so that it grabs the submodules, since ARM keyboards are becoming more common, and we are seeing more issues about chibiOS not being downloaded (in the error log, rather than by question)
* Wrap in shell
| -rw-r--r-- | docs/newbs_getting_started.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md index aefa1b738..ae4b799a9 100644 --- a/docs/newbs_getting_started.md +++ b/docs/newbs_getting_started.md @@ -66,8 +66,10 @@ You will need to install Git. It's very likely that you already have it, but if Once you have set up your Linux/Unix environment, you are ready to download QMK. We will do this by using Git to "clone" the QMK repository. Open a Terminal or MSYS2 MinGW window and leave it open for the remainder of this guide. Inside that window run these two commands: - git clone https://github.com/qmk/qmk_firmware.git - cd qmk_firmware +```shell +git clone --recurse-submodules https://github.com/qmk/qmk_firmware.git +cd qmk_firmware +``` ?> If you already know [how to use GitHub](getting_started_github.md), we recommend that you create and clone your own fork instead. If you don't know what that means, you can safely ignore this message. |