about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGriffin Smith <root@gws.fyi>2020-05-05T19·29-0400
committerGriffin Smith <root@gws.fyi>2020-05-05T19·29-0400
commiteb211c2701ad6437bbe5c846823b17acb1dcb1c7 (patch)
tree0f67fdefda7ff290b4eb7ce60905089b8454e60d
parent4e81c9b636ebfdcf2ed83a8ed1b138918d5296a6 (diff)
Add basic README, with build instructions
-rw-r--r--README.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 000000000000..b085883a1049
--- /dev/null
+++ b/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.