From 8497a45134bcd7cdfda59cfaef6d54a0c43608c3 Mon Sep 17 00:00:00 2001 From: Erez Zukerman Date: Sat, 28 May 2016 20:48:20 -0400 Subject: Adds a roadmap to the intro section of the docs --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 646fa6f2b1..2513935d23 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,17 @@ This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If y The OLKB product firmwares are maintained by Jack, the Ergodox EZ by Erez, and the Clueboard by [Zach White](https://github.com/skullydazed). -## Important background info: TMK documentation +## Documentation roadmap -The documentation below explains QMK customizations and elaborates on some of the more useful features of TMK. To understand the base firmware, and especially what *layers* are and how they work, please see [TMK_README.md](/TMK_README.md). +This is not a tiny project. While this is the main Readme, there are many other files you might want to consult. Here are some points of interest: + +* The Readme for your own keyboard: This is found under `keyboards//'. So for the ErgoDox EZ, it's [here](/tree/master/keyboard/ergodox_ez/); for the Atomic, it's [here](/tree/master/keyboard/atomic/) and so on. +* The [build guide](BUILD_GUIDE.md), also mentioned in the next section. This is how you put your development environment together so you can compile the firmware. +* The list of possible keycodes you can use in your keymap is actually spread out in a few different places: + * [tmk_core/common/keycode.h](/blob/master/tmk_core/common/keycode.h) - the base TMK keycodes. This is the actual source file. + * [tmk_core/doc/keycode.txt](/blob/master/tmk_core/doc/keycode.txt) - an explanation of those same keycodes. + * [quantum/keymap_common.h](/blob/master/quantum/keymap_common.h) - this is where the QMK-specific aliases are all set up. Things like the Hyper and Meh key, the Leader key, and all of the other QMK innovations. These are also explained and documented below, but `keymap_common.h` is where they're actually defined. +* The [TMK documentation](/tree/master/tmk_core/doc). QMK is based on TMK, and this explains how it works internally. ## Getting started -- cgit v1.2.3 From d7ed882d2a32dd0cf1df66c204f5e52395726a41 Mon Sep 17 00:00:00 2001 From: Erez Zukerman Date: Sat, 28 May 2016 20:50:24 -0400 Subject: Corrects links --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2513935d23..9c8f926e25 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ The OLKB product firmwares are maintained by Jack, the Ergodox EZ by Erez, and t This is not a tiny project. While this is the main Readme, there are many other files you might want to consult. Here are some points of interest: -* The Readme for your own keyboard: This is found under `keyboards//'. So for the ErgoDox EZ, it's [here](/tree/master/keyboard/ergodox_ez/); for the Atomic, it's [here](/tree/master/keyboard/atomic/) and so on. +* The Readme for your own keyboard: This is found under `keyboards//'. So for the ErgoDox EZ, it's [here](keyboard/ergodox_ez/); for the Atomic, it's [here](keyboard/atomic/) and so on. * The [build guide](BUILD_GUIDE.md), also mentioned in the next section. This is how you put your development environment together so you can compile the firmware. * The list of possible keycodes you can use in your keymap is actually spread out in a few different places: - * [tmk_core/common/keycode.h](/blob/master/tmk_core/common/keycode.h) - the base TMK keycodes. This is the actual source file. - * [tmk_core/doc/keycode.txt](/blob/master/tmk_core/doc/keycode.txt) - an explanation of those same keycodes. - * [quantum/keymap_common.h](/blob/master/quantum/keymap_common.h) - this is where the QMK-specific aliases are all set up. Things like the Hyper and Meh key, the Leader key, and all of the other QMK innovations. These are also explained and documented below, but `keymap_common.h` is where they're actually defined. -* The [TMK documentation](/tree/master/tmk_core/doc). QMK is based on TMK, and this explains how it works internally. + * [tmk_core/common/keycode.h](tmk_core/common/keycode.h) - the base TMK keycodes. This is the actual source file. + * [tmk_core/doc/keycode.txt](tmk_core/doc/keycode.txt) - an explanation of those same keycodes. + * [quantum/keymap_common.h](quantum/keymap_common.h) - this is where the QMK-specific aliases are all set up. Things like the Hyper and Meh key, the Leader key, and all of the other QMK innovations. These are also explained and documented below, but `keymap_common.h` is where they're actually defined. +* The [TMK documentation](tmk_core/doc). QMK is based on TMK, and this explains how it works internally. ## Getting started -- cgit v1.2.3 From 536ad6813a452328d8b3437c55c1984f84eecc79 Mon Sep 17 00:00:00 2001 From: Erez Zukerman Date: Sat, 28 May 2016 20:51:25 -0400 Subject: Corrects a backtick --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9c8f926e25..2c82575285 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The OLKB product firmwares are maintained by Jack, the Ergodox EZ by Erez, and t This is not a tiny project. While this is the main Readme, there are many other files you might want to consult. Here are some points of interest: -* The Readme for your own keyboard: This is found under `keyboards//'. So for the ErgoDox EZ, it's [here](keyboard/ergodox_ez/); for the Atomic, it's [here](keyboard/atomic/) and so on. +* The Readme for your own keyboard: This is found under `keyboards//`. So for the ErgoDox EZ, it's [here](keyboard/ergodox_ez/); for the Atomic, it's [here](keyboard/atomic/) and so on. * The [build guide](BUILD_GUIDE.md), also mentioned in the next section. This is how you put your development environment together so you can compile the firmware. * The list of possible keycodes you can use in your keymap is actually spread out in a few different places: * [tmk_core/common/keycode.h](tmk_core/common/keycode.h) - the base TMK keycodes. This is the actual source file. -- cgit v1.2.3 From cc3972e7d6338febb306b384b939f5494ff8cdf9 Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 2 Jun 2016 14:23:01 -0400 Subject: adds travis badge --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2c82575285..c848d477d6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![Build Status](https://travis-ci.org/jackhumbert/qmk_firmware.svg?branch=master)](https://travis-ci.org/jackhumbert/qmk_firmware) # Quantum Mechanical Keyboard Firmware This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.co), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). -- cgit v1.2.3 From b36e532b5e0eef219f33075e6e60b68d104484ee Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Sat, 4 Jun 2016 00:10:47 -0400 Subject: cleans up folder structure * consolidates docs * deletes converter/ * updates .md references (most) --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c848d477d6..a6bd3c495e 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,18 @@ The OLKB product firmwares are maintained by Jack, the Ergodox EZ by Erez, and t This is not a tiny project. While this is the main Readme, there are many other files you might want to consult. Here are some points of interest: * The Readme for your own keyboard: This is found under `keyboards//`. So for the ErgoDox EZ, it's [here](keyboard/ergodox_ez/); for the Atomic, it's [here](keyboard/atomic/) and so on. -* The [build guide](BUILD_GUIDE.md), also mentioned in the next section. This is how you put your development environment together so you can compile the firmware. +* The [build guide](doc/BUILD_GUIDE.md), also mentioned in the next section. This is how you put your development environment together so you can compile the firmware. * The list of possible keycodes you can use in your keymap is actually spread out in a few different places: * [tmk_core/common/keycode.h](tmk_core/common/keycode.h) - the base TMK keycodes. This is the actual source file. - * [tmk_core/doc/keycode.txt](tmk_core/doc/keycode.txt) - an explanation of those same keycodes. + * [doc/keycode.txt](doc/keycode.txt) - an explanation of those same keycodes. * [quantum/keymap_common.h](quantum/keymap_common.h) - this is where the QMK-specific aliases are all set up. Things like the Hyper and Meh key, the Leader key, and all of the other QMK innovations. These are also explained and documented below, but `keymap_common.h` is where they're actually defined. -* The [TMK documentation](tmk_core/doc). QMK is based on TMK, and this explains how it works internally. +* The [TMK documentation](doc/TMK_README.md). QMK is based on TMK, and this explains how it works internally. ## Getting started -* [BUILD_GUIDE.md](BUILD_GUIDE.md) contains instructions to set up a build environment, build the firmware, and deploy it to a keyboard. Once your build environment has been set up, all `make` commands to actually build the firmware must be run from a folder in `keyboard/`. +* [BUILD_GUIDE.md](doc/BUILD_GUIDE.md) contains instructions to set up a build environment, build the firmware, and deploy it to a keyboard. Once your build environment has been set up, all `make` commands to actually build the firmware must be run from a folder in `keyboard/`. * If you're looking to customize a keyboard that currently runs QMK or TMK, find your keyboard's directory under `keyboard/` and run the make commands from there. -* If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `./new_project.sh `, which will create `/keyboard/` with all the necessary components for a Quantum project. +* If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `util/new_project.sh `, which will create `/keyboard/` with all the necessary components for a Quantum project. ### Makefile Options @@ -205,7 +205,7 @@ rounded up (5 bits per key). For example on Planck (48 keys) it uses ### Remember: These are just aliases -These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keymap.md#2-action). +These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/jackhumbert/qmk_firmware/blob/master/doc/keymap.md#2-action). Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them. -- cgit v1.2.3 From ea63714950c4fef930142c1b81626522dceb152c Mon Sep 17 00:00:00 2001 From: TuxForLife Date: Mon, 6 Jun 2016 07:42:41 -0700 Subject: Tiny typo (#386) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index a6bd3c495e..0990dd8341 100644 --- a/README.md +++ b/README.md @@ -176,7 +176,7 @@ void matrix_scan_user(void) { } ``` -As you can see, you have three function. you can use - `SEQ_ONE_KEY` for single-key sequences (Leader followed by just one key), and `SEQ_TWO_KEYS` and `SEQ_THREE_.EYS` for longer sequences. Each of these accepts one or more keycodes as arguments. This is an important point: You can use keycodes from **any layer on your keyboard**. That layer would need to be active for the leader macro to fire, obviously. +As you can see, you have three function. you can use - `SEQ_ONE_KEY` for single-key sequences (Leader followed by just one key), and `SEQ_TWO_KEYS` and `SEQ_THREE_KEYS` for longer sequences. Each of these accepts one or more keycodes as arguments. This is an important point: You can use keycodes from **any layer on your keyboard**. That layer would need to be active for the leader macro to fire, obviously. ### Temporarily setting the default layer -- cgit v1.2.3