summaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox/keymaps/romanzolotarev-norman-plover-osx/readme.md
diff options
context:
space:
mode:
authorFred Sundvik <fsundvik@gmail.com>2016-07-07 22:28:28 +0300
committerFred Sundvik <fsundvik@gmail.com>2016-07-29 20:48:04 +0300
commit9af995c59b2655fa347e43b1eab2122e72ef7fe3 (patch)
treef76ccbd3ab8c911ae851bb83d13173c5755c7162 /keyboards/ergodox/keymaps/romanzolotarev-norman-plover-osx/readme.md
parent30003d48f9a04676b81bf2980a235106ec7886b0 (diff)
Initial structure for Ergodox as subprojects
Only the EZ default keymaps compiles at the moment though.
Diffstat (limited to 'keyboards/ergodox/keymaps/romanzolotarev-norman-plover-osx/readme.md')
-rw-r--r--keyboards/ergodox/keymaps/romanzolotarev-norman-plover-osx/readme.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/keyboards/ergodox/keymaps/romanzolotarev-norman-plover-osx/readme.md b/keyboards/ergodox/keymaps/romanzolotarev-norman-plover-osx/readme.md
new file mode 100644
index 0000000000..804c52a767
--- /dev/null
+++ b/keyboards/ergodox/keymaps/romanzolotarev-norman-plover-osx/readme.md
@@ -0,0 +1,50 @@
+# Roman's Layout
+
+There are four layers:
+
+- **BASE** is [Norman layout](https://normanlayout.info/).
+- **SYMB** for numbers and symbols.
+- **PLVR** is optimized for [Plover](http://www.openstenoproject.org).
+- **ARRW** for navigation (same fingers for arrows as IJKL on QWERTY).
+
+Looking for HJKL arrows? [Here we
+go](../romanzolotarev-norman-plover-osx-hjkl/).
+
+[![keyboard-layout](romanzolotarev-norman-plover-osx.png)](http://www.keyboard-layout-editor.com/#/gists/8ebcb701ecb763944417)
+
+## Switching
+
+- Tap `SYMB` to toggle **SYMB**.
+- Tap `ARRW` to toggle **ARRW**.
+- Hold `SYMB` (or `ARRW`) to activate **SYMB** (or **ARRW**) while holding.
+- Tap `PLVR` to toggle **PLVR**.
+
+## LEDs
+
+- Red: SYMB is on.
+- Green: PLVR is on.
+- Blue: ARRW is on.
+
+## Functional Keys
+
+- Tap `F1` to mute microphone via [Shush](http://mizage.com/shush/).
+- Tap `F2` to copy screenshot to the clipboard.
+- Hold `SHIFT` and tap `F2` to save screenshot as a file.
+- Tap `F3`, `F4`, `F5`, `F6` to resize a window via [Divvy](http://mizage.com/divvy/).
+- Tap `F14`, `F15` to adjust display brightness.
+
+**IMPORTANT**: If you have another keyboard connected via Bluetooth, then
+`F14` and `F15` will not work. Turn off that Bluetooth keyboard. Re-plug
+you ErgoDox. Enjoy!
+
+## CTRL/ESC
+
+Both of those keys are frequently used in Vim.
+
+- Tap `CTRL/ESC` to send `ESC`.
+- Hold `CTRL/ESC` to use as `CTRL`.
+
+## Activate N-rollover
+
+- While in **BASE** hold left `SHIFT` and right `SHIRT` and then tap `N`.
+- Then you can activate **PLVR** and use ErgoDox EZ for steno.