-Things TO-DO
-============
-2. Flash NumLock led only when "numpad" layer is active
-3. Command (in terms of IS_COMMAND) to switch to no-leds mode
-4. Increase count of ACTION keys
-6. Fix command_state() onboard led: it should flash only when kbd in some specific mode (CONSOLE || MOUSE)
-7. ergodox_blink_all_leds() should save current state of leds, and restore after blink. initial state of all leds == off
-8. add support for pseudo-backlight (reversed LEDs) + docs/photo
-9. command to debug all LEDs (on/off/blink)
+# 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[]
+- [ ] create one-handed layouts, see
+ http://half-qwerty.com/
+ https://geekhack.org/index.php?topic=60165.0
+ https://www.massdrop.com/ext/ergodox/?hash=e097c3b9932179055023d47e48b25f1d