Add READMEHEADv0.1.0master

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..424a6d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+dome-key-map
+============
+
+The core of [DomeKey][1]. This library handles:
+
+* Parsing DomeKey map files
+* Running map actions (simulating key presses, running shell commands, modes)
+* Command-line argument parsing
+* Trial period
+
+
+## Building
+Run:
+
+	$ make release
+
+to build the `libdome_key_map.a` library.
+
+
+## License
+Copyright © 2018 Teddy Wing. This project is part of [DomeKey][1], and is
+published under the same license (see the included LICENSE file).
+
+
+[1]: https://domekey.teddywing.com/