diff options
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..3346df2a0 --- /dev/null +++ b/docs/README.md | |||
@@ -0,0 +1,32 @@ | |||
1 | # Quantum Mechanical Keyboard Firmware | ||
2 | |||
3 | ## Getting started | ||
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 | |||
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. | ||
13 | |||
14 | ### How to get it {#how-to-get-it} | ||
15 | |||
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. | ||
17 | |||
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`). | ||
19 | |||
20 | ### How to compile {#how-to-compile} | ||
21 | |||
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: | ||
23 | |||
24 | make planck-rev4-default | ||
25 | |||
26 | This would build the `rev4` revision of the `planck` with the `default` keymap. Not all keyboards have revisions (also called subprojects), in which case, it can be omitted: | ||
27 | |||
28 | make preonic-default | ||
29 | |||
30 | ### How to customize {#how-to-customize} | ||
31 | |||
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 | ||