forked from qmk/qmk_firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/qmk/qmk_firmware
* 'master' of https://github.com/qmk/qmk_firmware: (27 commits) Add Portuguese keymap and sendstring lookup tables (qmk#8390) Update link for Learn Plover google site (qmk#8410) [Keymap] ninjonas keymap updates (qmk#8373) Fix bootloader for Maypad (qmk#8411) Add decorators for determining keyboard and keymap based on current directory (qmk#8191) format code according to conventions [skip ci] Fix pressing two keys with the same keycode but different modifiers (qmk#2710) format code according to conventions [skip ci] Decouple mouse cursor and mouse wheel in accelerated mode (qmk#6685) [Keyboard] Add Wallaby (qmk#8398) [Keyboard] Abacus Keyboard ReMerge (qmk#8308) Restore getting_started_github.md doc Update Swedish keymap and add sendstring LUT (qmk#8365) Update Spanish keymap and sendstring LUT (qmk#8364) use qmk.path.normpath to locate the output file. [Keyboard] Candybar update (qmk#8335) Add new keymap with split shift and split backspace for bananas… (qmk#8395) Enable custom backlight driver for kmac (qmk#8397) Force "blank" issue template to end of list (qmk#8387) Fix darkmode (qmk#8393) ...
- Loading branch information
Showing
123 changed files
with
4,861 additions
and
2,163 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # How to Use Github with QMK | ||
|
|
||
| Github can be a little tricky to those that aren't familiar with it - this guide will walk through each step of forking, cloning, and submitting a pull request with QMK. | ||
|
|
||
| ?> This guide assumes you're somewhat comfortable with running things at the command line, and have git installed on your system. | ||
|
|
||
| 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 a part 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. Once your fork is completed (sometimes this takes a little while), click the "Clone or Download" button: | ||
|
|
||
|  | ||
|
|
||
| And be sure to select "HTTPS", and select the link and copy it: | ||
|
|
||
|  | ||
|
|
||
| From here, enter `git clone --recurse-submodules ` into the command line, and then paste your link: | ||
|
|
||
| ``` | ||
| user@computer:~$ git clone --recurse-submodules https://github.com/whoeveryouare/qmk_firmware.git | ||
| Cloning into 'qmk_firmware'... | ||
| remote: Enumerating objects: 9, done. | ||
| remote: Counting objects: 100% (9/9), done. | ||
| remote: Compressing objects: 100% (5/5), done. | ||
| remote: Total 183883 (delta 5), reused 4 (delta 4), pack-reused 183874 | ||
| Receiving objects: 100% (183883/183883), 132.90 MiB | 9.57 MiB/s, done. | ||
| Resolving deltas: 100% (119972/119972), done. | ||
| ... | ||
| Submodule path 'lib/chibios': checked out '587968d6cbc2b0e1c7147540872f2a67e59ca18b' | ||
| Submodule path 'lib/chibios-contrib': checked out 'ede48346eee4b8d6847c19bc01420bee76a5e486' | ||
| Submodule path 'lib/googletest': checked out 'ec44c6c1675c25b9827aacd08c02433cccde7780' | ||
| Submodule path 'lib/lufa': checked out 'ce10f7642b0459e409839b23cc91498945119b4d' | ||
| Submodule path 'lib/ugfx': checked out '3e97b74e03c93631cdd3ddb2ce43b963fdce19b2' | ||
| ``` | ||
|
|
||
| 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: | ||
|
|
||
| ``` | ||
| user@computer:~$ git add . | ||
| user@computer:~$ 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 | ||
| user@computer:~$ 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 | ||
| ``` | ||
|
|
||
| Your changes now exist on your fork on Github - if you go back there (`https://github.com/<whoeveryouare>/qmk_firmware`), you can create a "New Pull Request" by clicking this button: | ||
|
|
||
|  | ||
|
|
||
| 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": | ||
|
|
||
|  | ||
|
|
||
| After submitting, we may talk to you about your changes, ask that you make changes, and eventually accept it! Thanks for contributing to QMK :) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| .sidebar li.active { | ||
| background-color: #555; | ||
| } | ||
|
|
||
| .markdown-section p.tip, | ||
| .markdown-section tr:nth-child(2n) { | ||
| background-color:#444; | ||
| } | ||
|
|
||
| .markdown-section tr { | ||
| border-top: 1px solid #555; | ||
| } | ||
|
|
||
| .markdown-section td, .markdown-section th { | ||
| border: 1px solid #555; | ||
| } | ||
|
|
||
| .markdown-section p.tip code { | ||
| background-color: #555; | ||
| color: #fff; | ||
| } | ||
|
|
||
| .page_toc code { | ||
| background-color: #555; | ||
| } | ||
|
|
||
| .markdown-section hr, .search { | ||
| border-bottom: 1px solid #777 !important; | ||
| } |
File renamed without changes.
Oops, something went wrong.