From 57dcb951857c3ec2f96f3b53345e8b221e5348f2 Mon Sep 17 00:00:00 2001
From: Harald Albrecht <hidden@hidden.org>
Date: Tue, 8 Jan 2019 19:06:34 +0100
Subject: [PATCH] updates readme; adds comments to keyboard layout loading
 keys.lua

---
 README.md       | 28 +++++++++++++++++++++++++---
 sdcard/keys.lua | 10 +++++-----
 2 files changed, 30 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index fe0976c..789f2e1 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,7 @@ follows:
 
 ```lua
 require "layouts/shift" -- for cycling between layouts.
+require "layouts/media-player" -- indispensable media player controls.
 require "layouts/vsc-golang" -- debugging Go programs in VisualStudio Code.
 require "layouts/kdenlive" -- editing video using Kdenlive.
 require "layouts/empty" -- empty, do-nothing layout.
@@ -61,6 +62,27 @@ The default setup activates the following macro keyboard layouts shown below.
 > (top-left key in landscape), then tapping key #5 (immediately right to #11),
 > and finally releasing both keys.
 
+### Media Player Controls
+
+We start with the probably indispensable media player controls keyboard layout.
+'nuff said.
+
+```text
+┌╌╌╌╌┐  ┌╌╌╌╌┐  ┌╌╌╌╌┐  ┌╌╌╌╌┐
+┊ 11 ┊  ┊  8 ┊  ┊  5 ┊  ┊  2 ┊
+└╌╌╌╌┘  └╌╌╌╌┘  └╌╌╌╌┘  └╌╌╌╌┘
+          🔇     🔈/🔉     🔊
+┌╌╌╌╌┐  ┌╌╌╌╌┐  ┌╌╌╌╌┐  ┌╌╌╌╌┐
+┊ 10 ┊  ┊  7 ┊  ┊  4 ┊  ┊  1 ┊
+└╌╌╌╌┘  └╌╌╌╌┘  └╌╌╌╌┘  └╌╌╌╌┘
+                  ⏹️️
+┌╌╌╌╌┐  ┌╌╌╌╌┐  ┌╌╌╌╌┐  ┌╌╌╌╌┐
+┊  9 ┊  ┊  6 ┊  ┊  3 ┊  ┊  0 ┊
+└╌╌╌╌┘  └╌╌╌╌┘  └╌╌╌╌┘  └╌╌╌╌┘
+          ◀️◀️      ▮▶      ▶▶
+```
+
+
 ### Debug Go in VisualStudio Code
 
 Debug Go programs and packages in VisualStudio Code with its Go extension.
@@ -163,7 +185,7 @@ You may want to start from our template in `layouts/keymap-template.lua`.
 
 3. add key definitions for colors and handlers as necessary, see next for examples.
 
-    * you can specify key handlers either "inline", as you can see from the
+    - you can specify key handlers either "inline", as you can see from the
       example mapping for key #0:
 
       ```lua
@@ -176,7 +198,7 @@ You may want to start from our template in `layouts/keymap-template.lua`.
       This sets the key #0's LED color to white, and emits an "a" press everytime
       you tap key #0.
 
-    * for more complex handling, you may want to use a dedicated function instead:
+    - for more complex handling, you may want to use a dedicated function instead:
 
       ```lua
       function km.mypress(keyno)
@@ -188,7 +210,7 @@ You may want to start from our template in `layouts/keymap-template.lua`.
         [1] = { c={r=1, g=1, b=1}, press=km.mypress}
       }
 
-    * you can also do things on key releases:
+    - you can also do things on key releases:
 
       ```lua
       km.keymap = {
diff --git a/sdcard/keys.lua b/sdcard/keys.lua
index 1dea7dd..5652466 100644
--- a/sdcard/keys.lua
+++ b/sdcard/keys.lua
@@ -1,6 +1,6 @@
 require "keybow"
-require "layouts/shift"
-require "layouts/media-player"
-require "layouts/vsc-golang"
-require "layouts/kdenlive"
-require "layouts/empty"
+require "layouts/shift" -- for cycling between layouts.
+require "layouts/media-player" -- indispensable media player controls.
+require "layouts/vsc-golang" -- debugging Go programs in VisualStudio Code.
+require "layouts/kdenlive" -- editing video using Kdenlive.
+require "layouts/empty" -- empty, do-nothing layout.