Initial version of Ergodox-FAQ.md

diff --git a/README.md b/README.md
index 6596dc33256e4802db3c582f8199ab8c19d21029..2695b629fe99c8919fe6066c30288c503db8765a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -53,6 +53,7 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
 * [macway](keyboard/macway/)                - [Compact keyboard mod][GH_macway] [retired]
 * [KMAC](keyboard/kmac/)                    - Korean custom keyboard
 * [Lightsaber](keyboard/lightsaber/)        - Korean custom keyboard
+* [ErgoDox](keyboard/ergodox/)              - [ergonomic keyboard with split design][GH_ergodox] (see [Ergodox-FAQ.md](keyboard/ergodox/Ergodox-FAQ.md))
 
 [GH_macway]:    http://geekhack.org/showwiki.php?title=Island:11930
 [GH_hhkb]:      http://geekhack.org/showwiki.php?title=Island:12047
@@ -65,6 +66,7 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
 [GH_x68k]:      http://geekhack.org/showwiki.php?title=Island:29060
 [GH_hbkb]:      http://geekhack.org/showwiki.php?title=Island:29483
 [GH_ibm4704]:   http://geekhack.org/index.php?topic=54706.0
+[GH_ergodox]:   http://geekhack.org/index.php?topic=48106.0
 [HID_liber]:    http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
 [Phantom]:      http://geekhack.org/index.php?topic=26742
 [GH60]:         http://geekhack.org/index.php?topic=34959

diff --git a/keyboard/ergodox/Ergodox-FAQ.md b/keyboard/ergodox/Ergodox-FAQ.md
new file mode 100644 (file)
index 0000000..df55252
--- /dev/null
+++ b/keyboard/ergodox/Ergodox-FAQ.md
@@ -0,0 +1,29 @@
+Firmware
+========
+
+Q: Where to get binaries?
+A:
+
+Q: Where to get sources?
+A:
+
+Q: How to compile?
+A:
+
+
+Layouts
+=======
+
+description of layouts in base firmware binaries
+
+
+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)
+

diff --git a/keyboard/ergodox/TODO b/keyboard/ergodox/TODO
deleted file mode 100644 (file)
index 2144ec2..0000000
--- a/keyboard/ergodox/TODO
+++ /dev/null
@@ -1,9 +0,0 @@
-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)