summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Vincent <jesse@fsck.com>2018-12-09 12:30:16 -0800
committerGitHub <noreply@github.com>2018-12-09 12:30:16 -0800
commite56f0a30070cee10847ba7268212a788a68ff5d5 (patch)
treec80a6a07409fadd27bbef74584f517a0440d451e
parent0175207ea7932cde8717a0b52919f82e0ec6a53d (diff)
parent852566ee1c0d79643ea2940bd769757fb6d72a0c (diff)
downloadmodel01-firmware-e56f0a30070cee10847ba7268212a788a68ff5d5.tar.gz
model01-firmware-e56f0a30070cee10847ba7268212a788a68ff5d5.tar.bz2
model01-firmware-e56f0a30070cee10847ba7268212a788a68ff5d5.zip
Merge pull request #72 from tych0/doc-fixups
Doc fixups
-rw-r--r--Model01-Firmware.ino18
1 files changed, 14 insertions, 4 deletions
diff --git a/Model01-Firmware.ino b/Model01-Firmware.ino
index b6a556c..951e24c 100644
--- a/Model01-Firmware.ino
+++ b/Model01-Firmware.ino
@@ -108,9 +108,15 @@ enum { MACRO_VERSION_INFO,
* using ___ to let keypresses fall through to the previously active layer
* using XXX to mark a keyswitch as 'blocked' on this layer
* using ShiftToLayer() and LockLayer() keys to change the active keymap.
- * the special nature of the PROG key
* keeping NUM and FN consistent and accessible on all layers
*
+ * The PROG key is special, since it is how you indicate to the board that you
+ * want to flash the firmware. However, it can be remapped to a regular key.
+ * When the keyboard boots, it first looks to see whether the PROG key is held
+ * down; if it is, it simply awaits further flashing instructions. If it is
+ * not, it continues loading the rest of the firmware and the keyboard
+ * functions normally, with whatever binding you have set to PROG. More detail
+ * here: https://community.keyboard.io/t/how-the-prog-key-gets-you-into-the-bootloader/506/8
*
* The "keymaps" data structure is a list of the keymaps compiled into the firmware.
* The order of keymaps in the list is important, as the ShiftToLayer(#) and LockLayer(#)
@@ -412,17 +418,21 @@ KALEIDOSCOPE_INIT_PLUGINS(
// interface through which the keymap in EEPROM can be edited.
Focus,
- // FocusSettingsCommand adds a few Focus commands, intended to aid in changing some settings of the keyboard, such as the default layer (via the `settings.defaultLayer` command)
+ // FocusSettingsCommand adds a few Focus commands, intended to aid in
+ // changing some settings of the keyboard, such as the default layer (via the
+ // `settings.defaultLayer` command)
FocusSettingsCommand,
// FocusEEPROMCommand adds a set of Focus commands, which are very helpful in
// both debugging, and in backing up one's EEPROM contents.
FocusEEPROMCommand,
- // The boot greeting effect pulses the LED button for 10 seconds after the keyboard is first connected
+ // The boot greeting effect pulses the LED button for 10 seconds after the
+ // keyboard is first connected
BootGreetingEffect,
- // The hardware test mode, which can be invoked by tapping Prog, LED and the left Fn button at the same time.
+ // The hardware test mode, which can be invoked by tapping Prog, LED and the
+ // left Fn button at the same time.
TestMode,
// LEDControl provides support for other LED modes