diff options
| author | shela <shelaf@users.noreply.github.com> | 2019-12-21 20:00:22 +0900 |
|---|---|---|
| committer | Joel Challis <git@zvecr.com> | 2019-12-21 11:00:22 +0000 |
| commit | 52c18ef0265a8bb4b521b787f425c906a9180ef9 (patch) | |
| tree | acfcdf5b4866d96100a0822e5b729f870e72349b /docs/getting_started_github.md | |
| parent | d47809575662d3587924c306579f0b7e8c8809f1 (diff) | |
| download | qmk_firmware-52c18ef0265a8bb4b521b787f425c906a9180ef9.tar.gz qmk_firmware-52c18ef0265a8bb4b521b787f425c906a9180ef9.zip | |
[Docs] fix docs (#7642)
* [Docs] recurse-submodules option is need now
* [Docs] `tmk_core` folder is correct
* [Docs] fix typo
* [Docs] package scope has changed
* [Docs] Fix menu differences
* Update docs/arm_debugging.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/arm_debugging.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* fix typo
Co-authored-by: fauxpark <fauxpark@gmail.com>
Diffstat (limited to 'docs/getting_started_github.md')
| -rw-r--r-- | docs/getting_started_github.md | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/getting_started_github.md b/docs/getting_started_github.md index 629f4ece2..07f523f57 100644 --- a/docs/getting_started_github.md +++ b/docs/getting_started_github.md | |||
| @@ -16,17 +16,23 @@ And be sure to select "HTTPS", and select the link and copy it: | |||
| 16 | 16 | ||
| 17 |  | 17 |  |
| 18 | 18 | ||
| 19 | From here, enter `git clone ` into the command line, and then paste your link: | 19 | From here, enter `git clone --recurse-submodules ` into the command line, and then paste your link: |
| 20 | 20 | ||
| 21 | ``` | 21 | ``` |
| 22 | user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git | 22 | user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git |
| 23 | Cloning into 'qmk_firmware'... | 23 | Cloning into 'qmk_firmware'... |
| 24 | remote: Counting objects: 46625, done. | 24 | remote: Enumerating objects: 9, done. |
| 25 | remote: Compressing objects: 100% (2/2), done. | 25 | remote: Counting objects: 100% (9/9), done. |
| 26 | remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 | 26 | remote: Compressing objects: 100% (5/5), done. |
| 27 | Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. | 27 | remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 |
| 28 | Resolving deltas: 100% (29362/29362), done. | 28 | Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. |
| 29 | Checking out files: 100% (2799/2799), done. | 29 | Resolving deltas: 100% (119972/119972), done. |
| 30 | ... | ||
| 31 | Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' | ||
| 32 | Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' | ||
| 33 | Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' | ||
| 34 | Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' | ||
| 35 | Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' | ||
| 30 | ``` | 36 | ``` |
| 31 | 37 | ||
| 32 | You now have your QMK fork on your local machine, and you can add your keymap, compile it and flash it to your board. Once you're happy with your changes, you can add, commit, and push them to your fork like this: | 38 | You now have your QMK fork on your local machine, and you can add your keymap, compile it and flash it to your board. Once you're happy with your changes, you can add, commit, and push them to your fork like this: |