diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-06-29 19:35:33 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-06-29 19:35:33 -0400 |
| commit | b139633f89c45ef26d43732e94dad3e3fcb8fa60 (patch) | |
| tree | 0df4ad5834ee56da9b2d85c6adb44387b703c156 | |
| parent | 7da94ac51bf77d74b42ab63c06358ff59072289b (diff) | |
adds how to github
| -rw-r--r-- | docs/how_to_github.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/how_to_github.md b/docs/how_to_github.md new file mode 100644 index 0000000000..2f3da42fd4 --- /dev/null +++ b/docs/how_to_github.md @@ -0,0 +1,64 @@ +# How to use Github with QMK + +{% hint style='info' %} +This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system. +{% endhint %} + +Start on the [QMK Github page](https://github.com/qmk/qmk_firmware), and you'll see a button in the upper right that says "Fork": + + + +If you're apart of an organization, you'll need to choose which account to fork it to. In most circumstances, you'll want to fork it to your personal account. + +From there, click the "Clone or Download" button: + + + +And be sure to select "HTTPS", and select the link and copy it: + + + +From here, enter `git clone ` into the command line, and then paste your link: + +``` +**[terminal] +**[prompt you@computer]**[path ~]**[delimiter $ ]**[command git clone https://github.com/whoeveryouare/qmk_firmware.git] +Cloning into 'qmk_firmware'... +remote: Counting objects: 46625, done. +remote: Compressing objects: 100% (2/2), done. +remote: Total 46625 (delta 0), reused 0 (delta 0), pack-reused 46623 +Receiving objects: 100% (46625/46625), 84.47 MiB | 3.14 MiB/s, done. +Resolving deltas: 100% (29362/29362), done. +Checking out files: 100% (2799/2799), done. +**[prompt you@computer]**[path ~]**[delimiter $ ] +``` + +From here, 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: + +``` +**[terminal] +**[prompt you@computer]**[path ~/qmk_firmware]**[delimiter $ ]**[command git add .] +**[prompt you@computer]**[path ~/qmk_firmware]**[delimiter $ ]**[command git commit -m "adding my keymap"] +[master cccb1608] adding my keymap + 1 file changed, 1 insertion(+) + create mode 100644 keyboards/planck/keymaps/mine/keymap.c +**[prompt you@computer]**[path ~/qmk_firmware]**[delimiter $ ]**[command git push] +Counting objects: 1, done. +Delta compression using up to 4 threads. +Compressing objects: 100% (1/1), done. +Writing objects: 100% (1/1), 1.64 KiB | 0 bytes/s, done. +Total 1 (delta 1), reused 0 (delta 0) +remote: Resolving deltas: 100% (1/1), completed with 1 local objects. +To https://github.com/whoeveryouare/qmk_firmware.git + + 20043e64...7da94ac5 master -> master +``` + +If you go back to your fork on Github, you can create a "New Pull Request" by clicking this button: + + + +From here, you'll be able to see exactly what you've committed - if it all looks good, you can finalize it by clicking "Create Pull Request": + + + +From here, we may talk to you about your changes, ask that you make changes as we see fit, and eventually accept it! Thanks for contributing to QMK :)
\ No newline at end of file |