summaryrefslogtreecommitdiff
path: root/keyboards/splitography/keymaps/default/readme.md
diff options
context:
space:
mode:
authorAlexis Jeandeau <alexis.jeandeau@gmail.com>2021-11-17 11:59:03 +0900
committerGitHub <noreply@github.com>2021-11-16 18:59:03 -0800
commit3d49069a46b42d2a0e4d8b7537ac4ccf41e6402d (patch)
treea49bd00ad8c8055732b1a656f953d0d7e10d572f /keyboards/splitography/keymaps/default/readme.md
parent596511a959269097d640cf59fa0ad6ddb376b674 (diff)
[Keyboard] Add SOFT/HRUF Splitography keyboard (#15133)
Diffstat (limited to 'keyboards/splitography/keymaps/default/readme.md')
-rw-r--r--keyboards/splitography/keymaps/default/readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/keyboards/splitography/keymaps/default/readme.md b/keyboards/splitography/keymaps/default/readme.md
new file mode 100644
index 0000000000..b136d85efb
--- /dev/null
+++ b/keyboards/splitography/keymaps/default/readme.md
@@ -0,0 +1,14 @@
+# [Guide](https://softhruf.love/pages/guides)
+
+[Splitography quick start video](https://www.youtube.com/watch?v=ru4cRQ2s_v0)
+
+A short video guide on how to set up the SOFT/HRUF Splitography, a mechanical keyboard intended for use with [Plover](https://www.openstenoproject.org/plover/).
+
+Here is a reference card for the standard keyboard layout:
+
+![Reference card](https://i.imgur.com/ywe8jXR.png)
+
+* While holding down a colored thumb key, the matching colored functions/characters on the remaining keys can be pressed.
+* Bottom edge keys are accessed by holding down both keys.
+* Numlock locks in the Numpad layer.
+* Alt and Shift pressed simultaneously to return to the standard layout.