summaryrefslogtreecommitdiff
path: root/keyboards/kbdfans/niu_mini/keymaps/yttyx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kbdfans/niu_mini/keymaps/yttyx/README.md')
-rw-r--r--keyboards/kbdfans/niu_mini/keymaps/yttyx/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/keyboards/kbdfans/niu_mini/keymaps/yttyx/README.md b/keyboards/kbdfans/niu_mini/keymaps/yttyx/README.md
new file mode 100644
index 0000000000..ff3937c232
--- /dev/null
+++ b/keyboards/kbdfans/niu_mini/keymaps/yttyx/README.md
@@ -0,0 +1,32 @@
+# 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 niu_mini:yttyx
+```
+
+## To flash (example)
+
+```
+sudo dfu-programmer atmega32u4 erase
+sudo dfu-programmer atmega32u4 flash niu_mini_yttyx.hex --debug 6
+sudo dfu-programmer atmega32u4 launch
+```
+
+## 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)