summaryrefslogtreecommitdiffstats
path: root/keyboards/planck/keymaps/am/readme.md
diff options
context:
space:
mode:
authorantonio miranda <antsmiranda@gmail.com>2018-09-05 22:41:27 +0200
committerDrashna Jaelre <drashna@live.com>2018-09-05 22:41:27 +0200
commit2b09900bdc7f93d917cfd159f5e3b045612a7b85 (patch)
tree9b904b9740ddd15cba0d08ff81f89d824e540804 /keyboards/planck/keymaps/am/readme.md
parente5465e1c57f1ae6b71e1e665e4afd5f5e3909a89 (diff)
downloadqmk_firmware-2b09900bdc7f93d917cfd159f5e3b045612a7b85.tar.gz
qmk_firmware-2b09900bdc7f93d917cfd159f5e3b045612a7b85.tar.xz
Keymap: Add am keymap (#3843)
* Add am keymap * Add configuration to play nice with stuck modifiers This is in particular useful with emacs since its easy to get ctrl stuck * Deactivate mouse keys and backlight * Add control/esc and shift/enter taps * Remove DVORAK and PLOVER I won't be using this soon, so getting some free space * Raiser and Lower ideas from jeebak * Add cursor and mouse layers * Enable mouse keys * Switch underscore with minus * Disable audio and fix warnings * Update to the upstream changes * VIM line motion symbols on the raise layer * Enable sound and freeup some media keys on layers * Fix whitespace on keymap * Code review changes * Improve keymap documentation * Improve keymap to match to the default one * Restore DEFAULT_FOLDER to the default value * Fix config.h unescaped line
Diffstat (limited to 'keyboards/planck/keymaps/am/readme.md')
-rw-r--r--keyboards/planck/keymaps/am/readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/am/readme.md b/keyboards/planck/keymaps/am/readme.md
new file mode 100644
index 000000000..6e0601bf2
--- /dev/null
+++ b/keyboards/planck/keymaps/am/readme.md
@@ -0,0 +1,17 @@
+# The Am Planck Layout
+
+Heavily inspired by other layouts out there, and fine tuned to work well on emacs (most recently spacemacs with vim bindings).
+
+It features:
+
+- Media keys (bottom right)
+- Focused on Qwerty and Colemak
+- Number pads (normal and reversed)
+- TouchCursor layer
+- Mouse layer
+
+## Build
+
+Making planck/rev4 with keymap am and target dfu
+
+ make planck/rev4:am:dfu