Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware

[qmk_firmware.git] / keyboards / ergodox / keymaps / romanzolotarev-norman-osx / readme.md

diff --git a/keyboards/ergodox/keymaps/romanzolotarev-norman-osx/readme.md b/keyboards/ergodox/keymaps/romanzolotarev-norman-osx/readme.md
index 80475ab21e73918c9ba1e341242b0dce5d23e297..a86061285af289900654ed6e46ff6d01e3daebb8 100644 (file)
--- a/keyboards/ergodox/keymaps/romanzolotarev-norman-osx/readme.md
+++ b/keyboards/ergodox/keymaps/romanzolotarev-norman-osx/readme.md
@@ -1,28 +1,41 @@
 # Roman's Layout
 
-There is only one layer based on [Norman layout](https://normanlayout.info/).
+There is only one layer, and it is  based on [Norman
+layout](https://normanlayout.info/).
 
 Looking for multiple-layer layouts?
 
-- [Symbols, arrows, plover, HJKL arrows](../romanzolotarev-norman-plover-osx-hjkl/)
+- [Symbols, arrows, plover, HJKL
+  arrows](../romanzolotarev-norman-plover-osx-hjkl/)
 - [Same with IJKL arrows](../romanzolotarev-norman-plover-osx/)
 
 [![keyboard-layout](romanzolotarev-norman-osx.png)](http://www.keyboard-layout-editor.com/#/gists/9e89d54f1ea6eeeb7dab1b2d19d28195)
 
-## Functional Keys
+## How to use Vim key
 
-- 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/).
-
-## CTRL/ESC
-
-CTRL and ESC are frequently used in Vim.
+It is `CTL_T(KC_ESC)` and it works this way:
 
 - Tap `CTRL/ESC` to send `ESC`.
 - Hold `CTRL/ESC` to use as `CTRL`.
 
-## Activate N-rollover
+## How to activate N-rollover
 
 - Hold left `SHIFT` and right `SHIRT` and then tap `N`.
+
+## How to make and flash on OS X
+
+First you need to install few brew packages.
+
+```bash
+brew tap osx-cross/avr
+brew install dfu-programmer avr-libc teensy_loader_cli
+```
+
+Then you can clone this repository, make and flash your ErgoDox.
+
+```bash
+git clone https://github.com/romanzolotarev/qmk_firmware
+cd qmk_firmware/keyboards/ergodox
+# Optionally tweak ./keymaps/romanzolotarev-norman-osx/keymap.c
+SLEEP_LED_ENABLED=no KEYMAP=romanzolotarev-norman-osx make teensy
+```