summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPete Johanson <peter@peterjohanson.com>2020-05-01 16:49:04 -0400
committerPete Johanson <peter@peterjohanson.com>2020-05-01 16:49:04 -0400
commit495cd0065863fe109d2124cae365d200b91c7dd7 (patch)
treefb9019384322ad946d23ec95b4da3964f17485df /README.md
parent8b4024fa3c909aaa4f31eb09602ea490d40b3224 (diff)
README file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..afa7f1c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# Zephyr Mechanical Keyboard (ZMK) Firmware
+
+This project is a complete work in progress, with absolutely nothing functioning yet. The goal is to explore a new MK firmware
+with a less restritive license and better BLE support, built on top of the [Zephyr Project](https://www.zephyrproject.org/)
+