From d6c4e05cf92aa4e68b1b68aa510f9dee1b8a7585 Mon Sep 17 00:00:00 2001
From: kemonine <kemonine@kemonine.info>
Date: Fri, 21 Jan 2022 21:03:57 -0500
Subject: [PATCH] start work on qmk user keymaps

---
 qmk/.gitignore              |  1 +
 qmk/README.md               | 58 +++++++++++++++++++++++++++++++++++++
 qmk/user/kemonine/README.md |  3 ++
 3 files changed, 62 insertions(+)
 create mode 100644 qmk/.gitignore
 create mode 100644 qmk/README.md
 create mode 100644 qmk/user/kemonine/README.md

diff --git a/qmk/.gitignore b/qmk/.gitignore
new file mode 100644
index 00000000..329f3e5f
--- /dev/null
+++ b/qmk/.gitignore
@@ -0,0 +1 @@
+.build/
\ No newline at end of file
diff --git a/qmk/README.md b/qmk/README.md
new file mode 100644
index 00000000..17adea78
--- /dev/null
+++ b/qmk/README.md
@@ -0,0 +1,58 @@
+# QMK Notes
+
+## Inspiration
+
+- https://git.sr.ht/~sungo/qmk_userspace/tree/main
+
+## Compiling
+
+``` sh
+qmk compile -kb tidbit -km kemonine
+```
+
+## Docker Critical
+
+### Docker Run
+
+``` sh
+# PowerShell
+#     Use ` instead of \
+#     Use ${PWD} instead of $(pwd)
+docker run --rm -it \
+  -v qmk_firmware:/qmk_firmware \
+  -v ${PWD}/.build:/qmk_firmware/.build \
+  -v ${PWD}/kemonine:/qmk_firmware/users/kemonine \
+  qmkfm/qmk_cli /bin/bash
+ ```
+
+### Update / Clone Sources
+
+``` sh
+# PowerShell
+#     Use ` instead of \
+docker run --rm -it `
+  -v qmk_firmware:/qmk_firmware \
+  qmkfm/qmk_cli /bin/bash
+
+cd /qmk_firmware
+if [ -d .git ]; 
+then 
+git pull; 
+else 
+git clone https://github.com/qmk/qmk_firmware.git .; 
+fi
+```
+
+### Docker Volumes
+
+#### QMK Sources
+
+`qmkfm/qmk_cli` lacks sources. Use named volume to speed dev and output
+
+#### KemoNine
+
+Need to have the `qmk/users/kemonine` directory mounted at `/qmk_firmware/users/kemonine` in Docker container
+
+#### Build output
+
+Need to have a local dir for build artifact extraction at `/qmk_firmware/.build`
diff --git a/qmk/user/kemonine/README.md b/qmk/user/kemonine/README.md
new file mode 100644
index 00000000..fcb728da
--- /dev/null
+++ b/qmk/user/kemonine/README.md
@@ -0,0 +1,3 @@
+# KemoNine's QMK Code
+
+See title
\ No newline at end of file