Add usage in README

2022-05-03 23:09:26 +02:00 · 2022-05-03 23:09:26 +02:00 · 7ad7f5c1de
commit 7ad7f5c1de
parent e0624375af
1 changed files with 8 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,8 @@
+# MassDrop Shift Keyboard Compiler
+This tool bundles all provided tools into a simple Makefile. This compiles and writes the given layout.
+
+## Usage
+To write the layout `my-layout` to the keyboard, run:
+```sh
+make write WRITE_TARGET=my-layout
+```