drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[Docs] Encourage newbs to not download the repo as a zip (#7353)

Browse source 
* Encourage newbs to not download the repo as a zip

* Tweak wording and remove Russian translation of deprecated Vista+ instructions
This commit is contained in:
fauxpark 2019-11-15 06:37:18 +11:00 • committed by Drashna Jaelre
parent 872744f5ab
commit 5edd4b99fe
3 changed files with 1 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/README.md
View file

@ -15,7 +15,7 @@ QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains Q
If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](https://github.com/qmk/qmk_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](https://github.com/qmk/qmk_firmware/pulls) from your fork.
Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk_firmware/zipball/master), [tar](https://github.com/qmk/qmk_firmware/tarball/master)), or clone it via git (`git@github.com:qmk/qmk_firmware.git`), or https (`https://github.com/qmk/qmk_firmware.git`).
Otherwise, you can clone it directly with `git clone https://github.com/qmk/qmk_firmware`. Do not download the zip or tar files; a git repository is required to download the submodules in order to compile.
## How to Compile