about summary refs log tree commit diff
path: root/users/glittershark/keyboard/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'users/glittershark/keyboard/README.org')
-rw-r--r--users/glittershark/keyboard/README.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/users/glittershark/keyboard/README.org b/users/glittershark/keyboard/README.org
new file mode 100644
index 000000000000..b085883a1049
--- /dev/null
+++ b/users/glittershark/keyboard/README.org
@@ -0,0 +1,10 @@
+This repository contains the source of the keyboard layout for my Ergodox EZ,
+plus build tooling based on Nix.
+
+To flash to an Ergodox EZ that's connected to your computer via USB, run:
+
+#+BEGIN_SRC shell
+./flash
+#+END_SRC
+
+then press the reset switch on the keyboard.