Diverge3 - Workman Layout (#3682)

[qmk_firmware.git] / keyboards / diverge3 / keymaps / workman / readme.md

diff --git a/keyboards/diverge3/keymaps/workman/readme.md b/keyboards/diverge3/keymaps/workman/readme.md
new file mode 100644 (file)
index 0000000..48ba482
--- /dev/null
+++ b/keyboards/diverge3/keymaps/workman/readme.md
@@ -0,0 +1,21 @@
+# The Workman keymap for diverge3
+
+Basic example of the [Workman Programming Layout](https://github.com/ojbucao/workman) which uses the `SHIFT`ed variants of the number row, by default.
+
+## Layer 1 - Default Layer
+
+Workman programming layout.
+
+![Workman Layout Picture](https://i.imgur.com/IOOmRfI.png)
+
+## Layer 2 - Gaming Layer
+
+Reverts the number row to the normal 1, 2, 3, etc... for better gaming compatibility.
+
+![Gaming Layer Picture](https://i.imgur.com/E0vmEAa.png)
+
+## Layer 3 - Raise Layer
+
+Volume and backlight controls (although backlight is not fully functional using `USE_SERIAL` in `../config.h`).
+
+![Raise Layer Misc Buttons Picture](https://i.imgur.com/50L3O62.png)