From 3d85d1400daeb3bcbbb347a7f1b68b6e1675c9d4 Mon Sep 17 00:00:00 2001
From: Caleb White <cdwhite3@pm.me>
Date: Wed, 10 Jan 2024 13:37:44 -0600
Subject: [PATCH] chore: add readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..575422a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Wireless Corne ZMK Config
+
+My [ZMK](https://github.com/zmkfirmware/zmk) configs for my [Typeractive](https://typeractive.xyz/) Corne
+using the `nice!nano` MC and `nice!view` display.
+
+
+### Docker
+
+To build using Docker, simply execute `make`. The resulting firmware can then be found under `./firmware` to be flashed to the respective side of the Corne.
+
+Execute `make clean` to clean out the firmware files and build cache.
+
+Execute `make distclean` to remove the docker image used to build the firmware.
+
+
+### Layout
+
+Inspiration is taken from the [Miryoku](https://github.com/manna-harbour/miryoku_zmk) layout for the split layers and the keyboard layout is slightly modified from the [Engram](https://engram.dev) layout.