From b75ad215c85a53c34e170dba3c62093fc8655362 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 29 Jun 2017 12:25:29 -0400 Subject: use default base names --- docs/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/README.md (limited to 'docs/README.md') 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 @@ +# 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} + +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} + +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} + +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: + + make planck-rev4-default + +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: + + make preonic-default + +### 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 -- cgit v1.2.3 From d8e29b53fe5d57f2102b77f0ce9932cdb8b021b2 Mon Sep 17 00:00:00 2001 From: skullY Date: Mon, 3 Jul 2017 01:30:36 -0700 Subject: Update a bunch of docs --- docs/README.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) (limited to 'docs/README.md') 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 @@ # 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). -- cgit v1.2.3 From 9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a Mon Sep 17 00:00:00 2001 From: skullY Date: Sun, 6 Aug 2017 20:57:57 -0700 Subject: Doc updates from going through every file --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index 06597a2b6..09317d652 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,4 +22,4 @@ This would build the `rev4` revision of the `planck` with the `default` keymap. ## 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). +QMK has lots of [features](features.md) 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](keymap.md), and changing the [keycodes](keycodes.md). -- cgit v1.2.3 From c0a6935fb3748baea0c3c6d3fdbf07cc1f5e5609 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roy=20Wellington=20=E2=85=A3?= Date: Fri, 18 Aug 2017 00:18:04 -0700 Subject: Fix these links, as they appear to be broken (#1595) It looks like build_environment_setup.md got renamed to getting_started_build_tools.md in this commit: commit e6c638bed1fa0a48bb6f8697b2a61717c4fd0992 Author: skullY Date: Sat Aug 5 20:54:34 2017 -0700 Overhaul the Getting Started section and add a FAQ section docs/{build_environment_setup.md => getting_started_build_tools.md} | 132 ++++++++++++++++++++++++++++++++++++------------------------------------- This commit adjusts the links to match the new name. --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/README.md') diff --git a/docs/README.md b/docs/README.md index 09317d652..515ddb778 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ Otherwise, you can either download it directly ([zip](https://github.com/qmk/qmk ## 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: +Before you are able to compile, you'll need to [install an environment](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: make planck-rev4-default -- cgit v1.2.3