Updates to Ergodox-FAQ.md

[tmk_firmware.git] / keyboard / ergodox / Ergodox-FAQ.md

diff --git a/keyboard/ergodox/Ergodox-FAQ.md b/keyboard/ergodox/Ergodox-FAQ.md
index 99f948b80b26920551f2eb24819820292ae3ad58..d70aac7451a196889fdd2f1bd723288354b41125 100644 (file)
--- a/keyboard/ergodox/Ergodox-FAQ.md
+++ b/keyboard/ergodox/Ergodox-FAQ.md
@@ -1,31 +1,68 @@
-Firmware
-========
+# TMK Generic
 
-Q: Where to get binaries?
-A:
+* I'm not sure what the Magic + H does.
+ Is this a menu that will pop up regardless of what platform and program is open? 
 
-Q: Where to get sources?
-A:
+ Yes, this is sort of debugging.
+ Use PJRC's [hid_listen](https://www.pjrc.com/teensy/hid_listen.html) to see debug messages.
 
-Q: How to compile?
-A:
+# TMK/Ergodox specific
 
+* I would like to configure my leds to indicate the active layer.
+ I read that can be done, but I haven't seen an example for this firmware.
+ Can someone please post an example or a link?
 
-Layouts
-=======
+ TMK for Ergodox have support for seven (!) led's:
+ - three on right
+ - three on left (see http://geekhack.org/index.php?topic=22780.msg873819#msg873819 for more details)
+ - Teensy onboard led as well
 
-description of layouts in base firmware binaries
+ Any of these leds can be used as layer indicator or NumLock/CapsLock/ScrollLock led.
 
+ [Here is example](https://github.com/cub-uanic/tmk_keyboard/blob/cub_layout/keyboard/ergodox/matrix.c#L121-167)
+ how you can assign some meaning to each led.
+ In this code only left leds are used to show layers, but you can
+ [change `led_set()`](https://github.com/cub-uanic/tmk_keyboard/blob/cub_layout/keyboard/ergodox/led.c)
+ and do anything you want with all leds.
 
-Things TO-DO
-============
-- Flash NumLock led only when "numpad" layer is active
-- Command (in terms of IS_COMMAND) to switch to no-leds mode
-- Increase count of ACTION keys
-- Fix command_state() onboard led: it should flash only when kbd in some specific mode (CONSOLE || MOUSE)
-- ergodox_blink_all_leds() should save current state of leds, and restore after blink. initial state of all leds == off
-- add support for pseudo-backlight (reversed LEDs) + docs/photo
-- command to debug all LEDs (on/off/blink)
-- proper (in-core) implementation of DEBUG_MATRIX_SCAN_RATE (non-Ergodox specific)
-- proper (in-core) support for per-layer fn_actions[]
+# Firmware
+
+#### Where to get binaries?
+https://github.com/cub-uanic/tmk_keyboard/releases
+
+#### Where to get sources?
+https://github.com/cub-uanic/tmk_keyboard/tree/master
+
+#### How to compile?
+
+    cd tmk_keyboard/keyboard/ergodox
+
+    # just to be safe
+    make -f Makefile.lufa clean
+
+    # use one of these
+    make -f Makefile.lufa
+    make -f Makefile.lufa dvorak
+    make -f Makefile.lufa colemak
+    make -f Makefile.lufa workman
+    make -f Makefile.lufa micro
+    make -f Makefile.lufa cub
+
+
+# Layouts
+
+TODO description of layouts in base firmware binaries
+
+
+# Things TO-DO
+
+- [ ] Flash NumLock led only when "numpad" layer is active
+- [ ] Command (in terms of IS_COMMAND) to switch to no-leds mode
+- [ ] Increase count of ACTION keys
+- [ ] Fix command_state() onboard led: it should flash only when kbd in some specific mode (CONSOLE || MOUSE)
+- [ ] ergodox_blink_all_leds() should save current state of leds, and restore after blink. initial state of all leds == off
+- [ ] add support for pseudo-backlight (reversed LEDs) + docs/photo
+- [ ] command to debug all LEDs (on/off/blink)
+- [ ] proper (in-core) implementation of DEBUG_MATRIX_SCAN_RATE (non-Ergodox specific)
+- [ ] proper (in-core) support for per-layer fn_actions[]