summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-07-03 01:30:36 -0700
committerskullY <skullydazed@gmail.com>2017-07-03 01:30:36 -0700
commitd8e29b53fe5d57f2102b77f0ce9932cdb8b021b2 (patch)
tree14dd7d4c51a3d0bb046acb29ad96ca2b5f76f55b /docs/README.md
parentea8df568f23b79eba13ef9e914d8b1ce94688858 (diff)
Update a bunch of docs
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md17
1 files changed, 5 insertions, 12 deletions
diff --git a/docs/README.md b/docs/README.md
index 3346df2a03..06597a2b69 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,23 +1,16 @@
# Quantum Mechanical Keyboard Firmware
-## Getting started
-
-* [What is QMK Firmware?](#what-is-qmk-firmware)
-* [How to get it](#how-to-get-it)
-* [How to compile](#how-to-compile)
-* [How to customize](#how-to-customize)
-
-### What is QMK Firmware? {#what-is-qmk-firmware}
+## What is QMK Firmware? {#what-is-qmk-firmware}
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.
-### How to get it {#how-to-get-it}
+## How to get it {#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.
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`).
-### How to compile {#how-to-compile}
+## How to compile {#how-to-compile}
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:
@@ -27,6 +20,6 @@ This would build the `rev4` revision of the `planck` with the `default` keymap.
make preonic-default
-### How to customize {#how-to-customize}
+## How to customize {#how-to-customize}
-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
+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).