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