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 ++++++++++++++++++++++++++++++++ docs/_summary.md | 3 +-- docs/home.md | 32 -------------------------------- 3 files changed, 33 insertions(+), 34 deletions(-) create mode 100644 docs/README.md delete mode 100644 docs/home.md (limited to 'docs') diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..3346df2a03 --- /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 diff --git a/docs/_summary.md b/docs/_summary.md index f2229be694..115132cd30 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -1,5 +1,4 @@ -* Getting started - * [Introduction](home.md) +* [Getting started](README.md) * [QMK Overview](qmk_overview.md) * [Build Environment Setup](build_environment_setup.md) * [Make instructions](make_instructions.md) diff --git a/docs/home.md b/docs/home.md deleted file mode 100644 index 3346df2a03..0000000000 --- a/docs/home.md +++ /dev/null @@ -1,32 +0,0 @@ -# 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