aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-06-29 12:13:44 -0400
committerJack Humbert <jack.humb@gmail.com>2017-06-29 12:13:44 -0400
commit391eae97e49de471a8320f05ed5c8976874aedb0 (patch)
tree4c1aebbd86af77bf31996352729053e1023f58b9
parentd59734d3b7f29b95645e96e8560b210f0991d744 (diff)
downloadqmk_firmware-391eae97e49de471a8320f05ed5c8976874aedb0.tar.gz
qmk_firmware-391eae97e49de471a8320f05ed5c8976874aedb0.zip
testing out new home
-rw-r--r--docs/_summary.md2
-rw-r--r--docs/features/README.md105
-rw-r--r--docs/home.md136
3 files changed, 123 insertions, 120 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index f2acad3a7..f2229be69 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -6,7 +6,7 @@
6 * [FAQ: Creating a Keymap](faq_keymap.md) 6 * [FAQ: Creating a Keymap](faq_keymap.md)
7 * [FAQ: Compiling QMK](faq_build.md) 7 * [FAQ: Compiling QMK](faq_build.md)
8 8
9* Features 9* [Features](features/README.md)
10 * [Layer switching](key_functions.md) 10 * [Layer switching](key_functions.md)
11 * [Leader Key](leader_key.md) 11 * [Leader Key](leader_key.md)
12 * [Macros](macros.md) 12 * [Macros](macros.md)
diff --git a/docs/features/README.md b/docs/features/README.md
new file mode 100644
index 000000000..72187d2d4
--- /dev/null
+++ b/docs/features/README.md
@@ -0,0 +1,105 @@
1# QMK Features
2
3
4## Space Cadet Shift: The future, built in
5
6Steve Losh [described](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/) the Space Cadet Shift quite well. Essentially, you hit the left Shift on its own, and you get an opening parenthesis; hit the right Shift on its own, and you get the closing one. When hit with other keys, the Shift key keeps working as it always does. Yes, it's as cool as it sounds. Head on over to the [Space Cadet Shift](space_cadet_shift.md) page to read about it.
7
8## The Leader key: A new kind of modifier
9
10Most modifiers have to be held or toggled. But what if you had a key that indicated the start of a sequence? You could press that key and then rapidly press 1-3 more keys to trigger a macro, or enter a special layer, or anything else you might want to do. To learn more about it check out the [Leader Key](leader_key.md) page.
11
12## Tap Dance: A single key can do 3, 5, or 100 different things
13
14Hit the semicolon key once, send a semicolon. Hit it twice, rapidly -- send a colon. Hit it three times, and your keyboard's LEDs do a wild dance. That's just one example of what Tap Dance can do. Read more about it on the [Tap Dance](tap_dance.md) page.
15
16## Temporarily setting the default layer
17
18`DF(layer)` - sets default layer to _layer_. The default layer is the one at the "bottom" of the layer stack - the ultimate fallback layer. This currently does not persist over power loss. When you plug the keyboard back in, layer 0 will always be the default. It is theoretically possible to work around that, but that's not what `DF` does.
19
20## Macro shortcuts: Send a whole string when pressing just one key
21
22How would you like a single keypress to send a whole word, sentence, paragraph, or even document? Head on over to the [Macros](macros.md) page to read up on all aspects of Simple and Dynamic Macros.
23
24## Additional keycode aliases for software-implemented layouts \(Colemak, Dvorak, etc\)
25
26Everything is assuming you're in Qwerty \(in software\) by default, but there is built-in support for using a Colemak or Dvorak layout by including this at the top of your keymap:
27
28```
29#include <keymap_colemak.h>
30```
31
32If you use Dvorak, use `keymap_dvorak.h` instead of `keymap_colemak.h` for this line. After including this line, you will get access to:
33
34* `CM_*` for all of the Colemak-equivalent characters
35* `DV_*` for all of the Dvorak-equivalent characters
36
37These implementations assume you're using Colemak or Dvorak on your OS, not on your keyboard - this is referred to as a software-implemented layout. If your computer is in Qwerty and your keymap is in Colemak or Dvorak, this is referred to as a firmware-implemented layout, and you won't need these features.
38
39To give an example, if you're using software-implemented Colemak, and want to get an `F`, you would use `CM_F`. Using `KC_F` under these same circumstances would result in `T`.
40
41## Backlight Breathing
42
43In order to enable backlight breathing, the following line must be added to your config.h file.
44
45```
46#define BACKLIGHT_BREATHING
47```
48
49The following function calls are used to control the breathing effect.
50
51* `breathing_enable()` - Enable the free-running breathing effect.
52* `breathing_disable()` - Disable the free-running breathing effect immediately.
53* `breathing_self_disable()` - Disable the free-running breathing effect after the current effect ends.
54* `breathing_toggle()` - Toggle the free-running breathing effect.
55* `breathing_defaults()` - Reset the speed and brightness settings of the breathing effect.
56
57The following function calls are used to control the maximum brightness of the breathing effect.
58
59* `breathing_intensity_set(value)` - Set the brightness of the breathing effect when it is at its max value.
60* `breathing_intensity_default()` - Reset the brightness of the breathing effect to the default value based on the current backlight intensity.
61
62The following function calls are used to control the cycling speed of the breathing effect.
63
64* `breathing_speed_set(value)` - Set the speed of the breathing effect - how fast it cycles.
65* `breathing_speed_inc(value)` - Increase the speed of the breathing effect by a fixed value.
66* `breathing_speed_dec(value)` - Decrease the speed of the breathing effect by a fixed value.
67* `breathing_speed_default()` - Reset the speed of the breathing effect to the default value.
68
69The following example shows how to enable the backlight breathing effect when the FUNCTION layer macro button is pressed:
70
71```
72case MACRO_FUNCTION:
73 if (record->event.pressed)
74 {
75 breathing_speed_set(3);
76 breathing_enable();
77 layer_on(LAYER_FUNCTION);
78 }
79 else
80 {
81 breathing_speed_set(1);
82 breathing_self_disable();
83 layer_off(LAYER_FUNCTION);
84 }
85 break;
86```
87
88The following example shows how to pulse the backlight on-off-on when the RAISED layer macro button is pressed:
89
90```
91case MACRO_RAISED:
92 if (record->event.pressed)
93 {
94 layer_on(LAYER_RAISED);
95 breathing_speed_set(2);
96 breathing_pulse();
97 update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
98 }
99 else
100 {
101 layer_off(LAYER_RAISED);
102 update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
103 }
104 break;
105``` \ No newline at end of file
diff --git a/docs/home.md b/docs/home.md
index df27ebdc5..3346df2a0 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -1,134 +1,32 @@
1# Quantum Mechanical Keyboard Firmware 1# Quantum Mechanical Keyboard Firmware
2 2
3You have found the QMK Firmware documentation site. This is a keyboard firmware based on the [tmk\_keyboard firmware](http://github.com/tmk/tmk_keyboard) \([view differences](differences_from_tmk.md)\) 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. 3## Getting started
4 4
5# Getting started 5* [What is QMK Firmware?](#what-is-qmk-firmware)
6* [How to get it](#how-to-get-it)
7* [How to compile](#how-to-compile)
8* [How to customize](#how-to-customize)
6 9
7Before you are able to compile, you'll need to install an environment for AVR or ARM development. You'll find the instructions for any OS below. If you find another/better way to set things up from scratch, please consider [making a pull request](https://github.com/qmk/qmk_firmware/pulls) with your changes! 10### What is QMK Firmware? {#what-is-qmk-firmware}
8 11
9* [Build Environment Setup](build_environment_setup.md) 12QMK (*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.
10* [QMK Overview](qmk_overview.md)
11 13
12# Configuring QMK Firmware 14### How to get it {#how-to-get-it}
13 15
14The QMK Firmware can be configured via the `keymaps` array data. For simply generating a [basic keycode](keycodes.md), you add it as an element of your `keymaps` array data. For more complicated actions, there are more advanced keycodes that are organized carefully to represent common operations, some of which can be found on the [Key Functions](key_functions.md) page. 16If 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.
15 17
16For more details of the `keymaps` array, see [Keymap Overview](keymap.md) page. 18Otherwise, 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`).
17 19
18## Space Cadet Shift: The future, built in 20### How to compile {#how-to-compile}
19 21
20Steve Losh [described](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/) the Space Cadet Shift quite well. Essentially, you hit the left Shift on its own, and you get an opening parenthesis; hit the right Shift on its own, and you get the closing one. When hit with other keys, the Shift key keeps working as it always does. Yes, it's as cool as it sounds. Head on over to the [Space Cadet Shift](space_cadet_shift.md) page to read about it. 22Before 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:
21 23
22## The Leader key: A new kind of modifier 24 make planck-rev4-default
23 25
24Most modifiers have to be held or toggled. But what if you had a key that indicated the start of a sequence? You could press that key and then rapidly press 1-3 more keys to trigger a macro, or enter a special layer, or anything else you might want to do. To learn more about it check out the [Leader Key](leader_key.md) page. 26This 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:
25 27
26## Tap Dance: A single key can do 3, 5, or 100 different things 28 make preonic-default
27 29
28Hit the semicolon key once, send a semicolon. Hit it twice, rapidly -- send a colon. Hit it three times, and your keyboard's LEDs do a wild dance. That's just one example of what Tap Dance can do. Read more about it on the [Tap Dance](tap_dance.md) page. 30### How to customize {#how-to-customize}
29
30## Temporarily setting the default layer
31
32`DF(layer)` - sets default layer to _layer_. The default layer is the one at the "bottom" of the layer stack - the ultimate fallback layer. This currently does not persist over power loss. When you plug the keyboard back in, layer 0 will always be the default. It is theoretically possible to work around that, but that's not what `DF` does.
33
34## Macro shortcuts: Send a whole string when pressing just one key
35
36How would you like a single keypress to send a whole word, sentence, paragraph, or even document? Head on over to the [Macros](macros.md) page to read up on all aspects of Simple and Dynamic Macros.
37
38## Additional keycode aliases for software-implemented layouts \(Colemak, Dvorak, etc\)
39
40Everything is assuming you're in Qwerty \(in software\) by default, but there is built-in support for using a Colemak or Dvorak layout by including this at the top of your keymap:
41
42```
43#include <keymap_colemak.h>
44```
45
46If you use Dvorak, use `keymap_dvorak.h` instead of `keymap_colemak.h` for this line. After including this line, you will get access to:
47
48* `CM_*` for all of the Colemak-equivalent characters
49* `DV_*` for all of the Dvorak-equivalent characters
50
51These implementations assume you're using Colemak or Dvorak on your OS, not on your keyboard - this is referred to as a software-implemented layout. If your computer is in Qwerty and your keymap is in Colemak or Dvorak, this is referred to as a firmware-implemented layout, and you won't need these features.
52
53To give an example, if you're using software-implemented Colemak, and want to get an `F`, you would use `CM_F`. Using `KC_F` under these same circumstances would result in `T`.
54
55## Backlight Breathing
56
57In order to enable backlight breathing, the following line must be added to your config.h file.
58
59```
60#define BACKLIGHT_BREATHING
61```
62
63The following function calls are used to control the breathing effect.
64
65* `breathing_enable()` - Enable the free-running breathing effect.
66* `breathing_disable()` - Disable the free-running breathing effect immediately.
67* `breathing_self_disable()` - Disable the free-running breathing effect after the current effect ends.
68* `breathing_toggle()` - Toggle the free-running breathing effect.
69* `breathing_defaults()` - Reset the speed and brightness settings of the breathing effect.
70
71The following function calls are used to control the maximum brightness of the breathing effect.
72
73* `breathing_intensity_set(value)` - Set the brightness of the breathing effect when it is at its max value.
74* `breathing_intensity_default()` - Reset the brightness of the breathing effect to the default value based on the current backlight intensity.
75
76The following function calls are used to control the cycling speed of the breathing effect.
77
78* `breathing_speed_set(value)` - Set the speed of the breathing effect - how fast it cycles.
79* `breathing_speed_inc(value)` - Increase the speed of the breathing effect by a fixed value.
80* `breathing_speed_dec(value)` - Decrease the speed of the breathing effect by a fixed value.
81* `breathing_speed_default()` - Reset the speed of the breathing effect to the default value.
82
83The following example shows how to enable the backlight breathing effect when the FUNCTION layer macro button is pressed:
84
85```
86case MACRO_FUNCTION:
87 if (record->event.pressed)
88 {
89 breathing_speed_set(3);
90 breathing_enable();
91 layer_on(LAYER_FUNCTION);
92 }
93 else
94 {
95 breathing_speed_set(1);
96 breathing_self_disable();
97 layer_off(LAYER_FUNCTION);
98 }
99 break;
100```
101
102The following example shows how to pulse the backlight on-off-on when the RAISED layer macro button is pressed:
103
104```
105case MACRO_RAISED:
106 if (record->event.pressed)
107 {
108 layer_on(LAYER_RAISED);
109 breathing_speed_set(2);
110 breathing_pulse();
111 update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
112 }
113 else
114 {
115 layer_off(LAYER_RAISED);
116 update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
117 }
118 break;
119```
120
121## Other firmware shortcut keycodes
122
123* `RESET` - puts the MCU in DFU mode for flashing new firmware \(with `make dfu`\)
124* `DEBUG` - the firmware into debug mode - you'll need hid\_listen to see things
125* `BL_ON` - turns the backlight on
126* `BL_OFF` - turns the backlight off
127* `BL_<n>` - sets the backlight to level _n_
128* `BL_INC` - increments the backlight level by one
129* `BL_DEC` - decrements the backlight level by one
130* `BL_TOGG` - toggles the backlight
131* `BL_STEP` - steps through the backlight levels
132
133Enable the backlight from the Makefile.
134 31
32QMK 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