Change keymaps of M0110

[tmk_firmware.git] / converter / m0110_usb / README.md

diff --git a/converter/m0110_usb/README.md b/converter/m0110_usb/README.md
index 1c344f1ac4210649c5c5e2d4d33ee5630d378b46..7de36d5de146455fbf7b9ffc3f5c444ac201b3cc 100644 (file)
--- a/converter/m0110_usb/README.md
+++ b/converter/m0110_usb/README.md
@@ -2,6 +2,8 @@ M0110/M0110A to USB keyboard converter
 ======================================
 This firmware converts the protocol of Apple Macintosh keyboard **M0110**, **M0110A** and **M0120** into USB. Target of this project is USB AVR controller **ATmega32U4**. Using this converter you can revive these retro keyboards with modern computer.
 
+Read README of top directory too.
+
 Pictures of **M0110 + M0120** and **M0110A**.
 
 ![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg)
@@ -17,6 +19,7 @@ Update
 ------
 - 2013/08: Change port for signals `PF` to `PD`
 - 2013/09: Change port again, it uses inversely `PD0` for data and `PD1` for clock line now.
+- 2014/06: Change keymaps
 
 
 
@@ -54,76 +57,22 @@ To compile firmware you need AVR GCC. You can edit *Makefile* and *config.h* to
 
     $ git clone git://github.com/tmk/tmk_keyboard.git (or download source)
     $ cd m0110_usb
-    $ make -f Makefile clean
-    $ make -f Makefile
+    $ make clean
+    $ make
+
+To select keymap use `KEYMAP` option.
 
-and program your Teensy with [PJRC Teensy loader](http://www.pjrc.com/teensy/loader.html).
+    $ make clean
+    $ make KEYMAP={plain|spacefn|hasu}
 
 
 
 Keymap
 ------
-You can change keymaps by editing *keymap.c*.
-
-### M0110 & M0120
-#### *Default Layer*
-    ,---------------------------------------------------------.     ,---------------.
-    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs|     |Clr|  -|Lft|Rgt|
-    |---------------------------------------------------------|     |---------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \|     |  7|  8|  9| Up|
-    |---------------------------------------------------------|     |---------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Enter |     |  4|  5|  6| Dn|
-    |---------------------------------------------------------|     |---------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift   |     |  1|  2|  3|   |
-    `---------------------------------------------------------'     |-----------|Ent|
-         |Ctl|Gui |         Space               |Alt |Ctl|          |      0|  .|   |
-         `-----------------------------------------------'          `---------------'
-
-- `Space` and  `Enter` also work as `Fn` layer switch key when holding down.
-
-#### *Function Layer(WASD/HHKB)*
-    ,---------------------------------------------------------.     ,---------------.
-    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet|     |Nlk|  -|Lft|Rgt|
-    |---------------------------------------------------------|     |---------------|
-    |Caps |Hom| Up|PgU|   |   |   |   |Psc|Slk|Pau|Up |Ins|  \|     |  7|  8|  9| Up|
-    |---------------------------------------------------------|     |---------------|
-    |Caps  |Lef|Dow|Rig|   |   |   |   |Hom|PgU|Lef|Rig|Enter |     |  4|  5|  6| Dn|
-    |---------------------------------------------------------|     |---------------|
-    |Shift   |End|   |PgD|   |   |   |   |End|PgD|Dow|Shift   |     |  1|  2|  3|   |
-    `---------------------------------------------------------'     |-----------|Ent|
-         |Ctl|Gui |         Space               |Alt |Ctl|          |      0|  .|   |
-         `-----------------------------------------------'          `---------------'
-
-
-### M0110A
-#### *Default Layer*
-    ,---------------------------------------------------------. ,---------------.
-    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs| |Clr|  =|  /|  *|
-    |---------------------------------------------------------| |---------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|   | |  7|  8|  9|  -|
-    |-----------------------------------------------------'   | |---------------|
-    |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Enter | |  4|  5|  6|  +|
-    |---------------------------------------------------------| |---------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shft| Up| |  1|  2|  3|   |
-    |---------------------------------------------------------| |-----------|Ent|
-    |Ctrl |Gui    |         Space             |  \|Lft|Rgt|Dwn| |      0|  .|   |
-    `---------------------------------------------------------' `---------------'
-
-- `Space` and  `Enter` also work as `Fn` layer switch key when holding down.
-- `Backslash(\)` also works as `Alt` when holding down.
-
-#### *Function Layer(WASD/HHKB)*
-    ,---------------------------------------------------------. ,---------------.
-    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| |Nlk|  =|  /|  *|
-    |---------------------------------------------------------| |---------------|
-    |Caps |Hom| Up|PgU|   |   |   |   |Psc|Slk|Pau|Up |Ins|   | |  7|  8|  9|  -|
-    |-----------------------------------------------------'   | |---------------|
-    |Caps  |Lef|Dow|Rig|   |   |   |   |Hom|PgU|Lef|Rig|Enter | |  4|  5|  6|  +|
-    |---------------------------------------------------------| |---------------|
-    |Shift   |End|   |PgD|   |   |   |   |End|PgD|Dow|Shif|PgU| |  1|  2|  3|   |
-    |---------------------------------------------------------| |-----------|Ent|
-    |Ctrl |Gui    |         Space             |  \|Hom|End|PgD| |      0|  .|   |
-    `---------------------------------------------------------' `---------------'
+To create your own keymap copy existent keymap file to `keymap_name.c` and edit it. You can build it like this.
+
+    $ make clean
+    $ make KEYMAP=name