From 69b015a7ee8eb320afef4a1ed26133902e0eb8ae Mon Sep 17 00:00:00 2001
From: innovaker <66737976+innovaker@users.noreply.github.com>
Date: Thu, 3 Dec 2020 10:30:46 +0000
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a83c7b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+Lightweight Docker images for [ZMK][zmk].
+
+### Platforms
+
+- `arm`
+
+### Images
+
+#### build
+
+For _building_ [ZMK][zmk] firmware with CI.
+
+- FROM: **[debian][debian]:stable-slim**
+- Includes:
+  - essential [Zephyr][zephyr] dependencies (`apt-get`)
+    - non-build dependencies are _not_ included. e.g. `pip3`, UI packages, etc.
+  - base [Zephyr][zephyr] Python requirements
+  - platform's [Zephyr][zephyr] toolchain
+
+#### dev
+
+For _developing_ [ZMK][zmk] (firmware and documentation).
+
+- FROM: **build**
+- Includes:
+  - remaining [Zephyr][zephyr] dependencies (`apt-get`)
+  - build and test [Zephyr][zephyr] Python requirements
+  - other useful development packages
+
+[debian]: https://hub.docker.com/_/debian "Debian"
+[zephyr]: https://github.com/zephyrproject-rtos/zephyr "Zephyr"
+[zmk]: https://github.com/zmkfirmware/zmk "ZMK"