diff options
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 17 |
1 files changed, 5 insertions, 12 deletions
diff --git a/docs/README.md b/docs/README.md index 3346df2a0..06597a2b6 100644 --- a/docs/README.md +++ b/docs/README.md | |||
@@ -1,23 +1,16 @@ | |||
1 | # Quantum Mechanical Keyboard Firmware | 1 | # Quantum Mechanical Keyboard Firmware |
2 | 2 | ||
3 | ## Getting started | 3 | ## What is QMK Firmware? {#what-is-qmk-firmware} |
4 | |||
5 | * [What is QMK Firmware?](#what-is-qmk-firmware) | ||
6 | * [How to get it](#how-to-get-it) | ||
7 | * [How to compile](#how-to-compile) | ||
8 | * [How to customize](#how-to-customize) | ||
9 | |||
10 | ### What is QMK Firmware? {#what-is-qmk-firmware} | ||
11 | 4 | ||
12 | QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, 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. | 5 | QMK (*Quantum Mechanical Keyboard*) is an open source community that maintains QMK Firmware, QMK Flasher, 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. |
13 | 6 | ||
14 | ### How to get it {#how-to-get-it} | 7 | ## How to get it {#how-to-get-it} |
15 | 8 | ||
16 | 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. | 9 | 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. |
17 | 10 | ||
18 | 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`). | 11 | 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`). |
19 | 12 | ||
20 | ### How to compile {#how-to-compile} | 13 | ## How to compile {#how-to-compile} |
21 | 14 | ||
22 | Before you are able to compile, you'll need to [install an environment](build_environment_setup.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: | 15 | Before you are able to compile, you'll need to [install an environment](build_environment_setup.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: |
23 | 16 | ||
@@ -27,6 +20,6 @@ This would build the `rev4` revision of the `planck` with the `default` keymap. | |||
27 | 20 | ||
28 | make preonic-default | 21 | make preonic-default |
29 | 22 | ||
30 | ### How to customize {#how-to-customize} | 23 | ## How to customize {#how-to-customize} |
31 | 24 | ||
32 | QMK has lots of [features](features/README.md) to explore, and a good deal of [reference documentation](reference/README.md) to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md). \ No newline at end of file | 25 | QMK has lots of [features](features/README.md) to explore, and a good deal of [reference documentation](reference/README.md) to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md). |