[Keymap] the results of some experiments and radically simplify keymap.c (#6172)

[qmk_firmware.git] / keyboards / planck / keymaps / callum / readme.md

diff --git a/keyboards/planck/keymaps/callum/readme.md b/keyboards/planck/keymaps/callum/readme.md
index 176211cd4bcee3589c92c74b16df0c12b4a2ce11..190c2b23a552fb0ff61d7d4650c4380571643802 100644 (file)
--- a/keyboards/planck/keymaps/callum/readme.md
+++ b/keyboards/planck/keymaps/callum/readme.md
@@ -1,11 +1,11 @@
-# callum’s planck layout
+# callum's planck layout
 
 This is a layout for the grid planck, built with a few ideals in mind:
 
 - Consistent and minimal response times should be maintained. Keys that react
   differently depending on whether they are tapped or held, keys that react
-  differently if they are double tapped, etc. should be avoided -- they
-  inevitably send their keycode later than a normal key -- interrupting the
+  differently if they are double tapped, etc. should be avoided – they
+  inevitably send their keycode later than a normal key – interrupting the
   immediate feedback from the screen. Therefore we restrict ourselves to
   chording as our only means of getting more than one symbol out of a single
   physical key.
@@ -17,68 +17,22 @@ This is a layout for the grid planck, built with a few ideals in mind:
 - There should be two of every modifier (one on each side), otherwise certain
   long key combinations become hard to make.
 
-Keys are arranged as follows. Blank keys below may actually contain
-undocumented shortcuts specific to my workflow. The base layer can be set to
-colemak or qwerty (from the function layer).
+- It should be possible to do things you might want to do while using the mouse
+  with only the left hand (e.g. change tabs, navigate back or forwards in
+  browser history).
 
-```
-/* COLEMAK
- * ,-----------------------------------------------------------------------.
- * |Tab  |  Q  |  W  |  F  |  P  |  G  |  J  |  L  |  U  |  Y  |  ;  |  -  |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |Bksp |  A  |  R  |  S  |  T  |  D  |  H  |  N  |  E  |  I  |  O  |  '  |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |Shift|  Z  |  X  |  C  |  V  |  B  |  K  |  M  |  ,  |  .  |  /  |Shift|
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |FUNC |Super| Alt |Ctrl |SYMB |Enter|Space|MOVE |Ctrl | Alt |Super|FUNC |
- * `-----------------------------------------------------------------------'
- */
+- Symbols should be arranged so that the most frequently used are easiest to
+  reach. This includes numbers, and lower numbers are more commonly used than
+  higher ones. (number arrangement borrowed from [dustypomeleau's minidox
+  layout][].
 
-/* QWERTY
- * ,-----------------------------------------------------------------------.
- * |Tab  |  Q  |  W  |  E  |  R  |  T  |  Y  |  U  |  I  |  O  |  P  |  -  |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |Bksp |  A  |  S  |  D  |  F  |  G  |  H  |  J  |  K  |  L  |  ;  |  '  |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |Shift|  Z  |  X  |  C  |  V  |  B  |  N  |  M  |  ,  |  .  |  /  |Shift|
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |FUNC |Super| Alt |Ctrl |SYMB |Enter|Space|MOVE |Ctrl | Alt |Super|FUNC |
- * `-----------------------------------------------------------------------'
- */
+Layout rendered with [keyboard-layout-editor.com][]:
 
-/* SYMB
- * ,-----------------------------------------------------------------------.
- * | Esc |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |     |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * | Del |  !  |  @  |  #  |  $  |  %  |  ^  |  &  |  *  |  (  |  )  |     |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |     |  ~  |  `  |  +  |  =  |  |  |  \  |  [  |  ]  |  {  |  }  |     |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |     |     |     |     |     |     |     |     |     |     |     |     |
- * `-----------------------------------------------------------------------'
- */
+![](https://callum-oakley.github.io/images/keymap.png)
 
-/* MOVE
- * ,-----------------------------------------------------------------------.
- * |     |     |     |     |     |     |     |Home | Up  | End |     | Esc |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |     |     |     |     |     |     |     |Left |Down |Right|Caps | Del |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |     |     |     |     |     |     |     |PgDn |PgUp |     |     |     |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |     |     |     |     |     |     |     |     |     |     |     |     |
- * `-----------------------------------------------------------------------'
- */
+The only behaviour not captured in this graphic is: pressing both cmd keys will
+send cmd+ctrl. See [keymap.c][] for details.
 
-/* FUNC
- * ,-----------------------------------------------------------------------.
- * |Reset| F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 |VolUp|
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |Power| F11 | F12 | F13 | F14 | F15 | F16 | F17 | F18 | F19 | F20 |VolDn|
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |     | F21 | F22 | F23 | F24 |     |     |     |     |COLMK|QWRTY|     |
- * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
- * |     |     |     |     |Prev |Mute |Play |Next |     |     |     |     |
- * `-----------------------------------------------------------------------'
- */
- ```
+[dustypomeleau's minidox layout]: https://github.com/qmk/qmk_firmware/tree/master/keyboards/minidox/keymaps/dustypomerleau
+[keyboard-layout-editor.com]: http://www.keyboard-layout-editor.com
+[keymap.c]: keymap.c