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.
- Loading branch information
1 parent
4800385
commit f27060d
Showing
1 changed file
with
9 additions
and
9 deletions.
There are no files selected for viewing
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 |
|---|---|---|
| @@ -1,32 +1,32 @@ | ||
| # QMK Basics | ||
|
|
||
| [](https://github.com/qmk/qmk_firmware/tags) [](https://travis-ci.org/qmk/qmk_firmware) [](https://discord.gg/Uq7gcHh) [](https://docs.qmk.fm) [](https://github.com/qmk/qmk_firmware/pulse/monthly) [](https://github.com/qmk/qmk_firmware/) | ||
| [](https://github.com/qmk/qmk\_firmware/tags) [](https://travis-ci.org/qmk/qmk\_firmware) [](https://discord.gg/Uq7gcHh) [](https://docs.qmk.fm) [](https://github.com/qmk/qmk\_firmware/pulse/monthly) [](https://github.com/qmk/qmk\_firmware/) | ||
|
|
||
| ## What is QMK Firmware? | ||
|
|
||
| QMK \(_Quantum Mechanical Keyboard_\) is an open source community that maintains QMK Firmware, QMK Toolbox, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB. | ||
| QMK (_Quantum Mechanical Keyboard_) is an open source community that maintains QMK Firmware, QMK Toolbox, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk\_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB. | ||
|
|
||
| ## How to Get It | ||
|
|
||
| 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. | ||
| 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 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 | ||
|
|
||
| Before you are able to compile, you'll need to [install an environment](../detailed-guides/getting_started_build_tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation: | ||
| Before you are able to compile, you'll need to [install an environment](../detailed-guides/getting\_started\_build\_tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation: | ||
|
|
||
| ```text | ||
| make planck/rev4:default | ||
| ``` | ||
| <pre><code>make <a data-footnote-ref href="#user-content-fn-1">planck</a>/rev4:default | ||
| </code></pre> | ||
|
|
||
| This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions \(also called subprojects or folders\), in which case, it can be omitted: | ||
| This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects or folders), in which case, it can be omitted: | ||
|
|
||
| ```text | ||
| ``` | ||
| make preonic:default | ||
| ``` | ||
|
|
||
| ## How to Customize | ||
|
|
||
| QMK has lots of [features](../features/) to explore, and a good deal of [reference documentation](http://docs.qmk.fm) to dig through. Most features are taken advantage of by modifying your [keymap](../detailed-guides/keymap.md), and changing the [keycodes](../reference/keycodes.md). | ||
|
|
||
| [^1]: Test hello world!! |