Keymap: Add Koba's keymap for Ergo42. (#3965)

[qmk_firmware.git] / keyboards / ergo42 / keymaps / koba / readme.md

diff --git a/keyboards/ergo42/keymaps/koba/readme.md b/keyboards/ergo42/keymaps/koba/readme.md
new file mode 100644 (file)
index 0000000..1fe0543
--- /dev/null
+++ b/keyboards/ergo42/keymaps/koba/readme.md
@@ -0,0 +1,57 @@
+# Keymap for Ergo42
+
+## About
+
+This keymap is for Ergo42.
+
+- JIS layout.
+- Independent Windows layout/MacOS layout layers.
+- Bottom row keys arranged like a standard keyboard.
+- Arrow keys are designed in the inverted-T.
+
+## Layout
+
+![keyboard-layout](https://user-images.githubusercontent.com/1042121/45888288-aa35ed00-bdf8-11e8-8741-71fe9a0fadc6.png)
+
+## Windows mode/MacOS mode
+
+|mode        |key         |
+|------------|------------|
+|Windows mode|Function + g|
+|MacOS mode  |Function + b|
+
+When switching mode, the following keys switches.
+
+|Windows        |MacOS       |
+|---------------|------------|
+|Alt            |Command(GUI)|
+|Windows(GUI)   |Option(Alt) |
+|Menu(App)      |Command(GUI)|
+|Muhenkan       |Eisu        |
+|Henkan         |Kana        |
+|Hankaku/Zenkaku|Caps        |
+
+## Layers
+
+|No.|Name    |Description                |
+|---|--------|---------------------------|
+| 4 |Function|Mode switch, Media         |
+| 3 |Raise   |Number, Function           |
+| 2 |Lower   |Symbol, Home/End, PgUp/PgDn|
+| 1 |MacOS   |MacOS layout               |
+| 0 |Windows |Windows layout             |
+
+When power is turn on, No.0 Windows layer becomes enabled.
+
+## Windows/MacOS layers
+
+Standard layers for Windows mode/MacOS mode.
+
+## Raise/Lower layers
+
+Layer enabled during pressing Raise or Lower key.
+
+## Function layer
+
+Layer enabled during pressing Function key.
+