summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/yttyx/README.md
diff options
context:
space:
mode:
authoryttyx <yttyx@users.noreply.github.com>2020-05-27 02:17:16 +0100
committerGitHub <noreply@github.com>2020-05-27 02:17:16 +0100
commit10c1e1b3abd5c91dd498610c985a9f4873a20288 (patch)
tree131ddbfe3810b72a635476b228675666d3bb2966 /keyboards/planck/keymaps/yttyx/README.md
parent00c1401d3c3b6d5d672719f21795c10a387d15c8 (diff)
[Keymap] Update yttyx Planck keymap (#9191)
* Normalise layout and README from yttyx niu keymap. * Correct case of README. * Changes following review. Co-authored-by: Nick Willis <nick@theb.org.uk>
Diffstat (limited to 'keyboards/planck/keymaps/yttyx/README.md')
-rw-r--r--keyboards/planck/keymaps/yttyx/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/yttyx/README.md b/keyboards/planck/keymaps/yttyx/README.md
new file mode 100644
index 0000000000..963438e3b0
--- /dev/null
+++ b/keyboards/planck/keymaps/yttyx/README.md
@@ -0,0 +1,30 @@
+# Overview
+
+This layout uses a mirror variant of Balance 12, created by Sasha Viminitz. See [this page](https://mathematicalmulticore.wordpress.com/the-keyboard-layout-project/)
+for more information.
+
+## To build
+
+```
+make planck/rev6:yttyx
+```
+
+## To build and flash
+
+```
+make planck/rev6:yttyx:flash
+```
+
+## Layers
+
+### Balance 12 base (BA) layer
+![Base layer](https://i.imgur.com/I0TkIHT.png)
+
+### Numeric/Punctuation (NP) layer
+![Numeric/Punctuation layer](https://i.imgur.com/GgZ0PCq.png)
+
+### Function/Cursor (FC) layer
+![Function/Cursor layer](https://i.imgur.com/zcVID2d.png)
+
+### Plover (PL) layer
+![Plover layer](https://i.imgur.com/RikOGXe.png)