aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..705aa27
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# What?
+
+Just a Dockerfile for an image to build [OpenAnnePro]'s firmware.
+
+## Build
+
+E.g.
+
+ docker build -t annepro2-build .
+
+
+## Use/run
+
+E.g.
+
+ cd /path/to/annepro2-shine
+ docker run --rm -it -u "$(id -u):$(id -g)" -w /src -v "$PWD:/src" annepro2-build
+ [I have no name!@b448316196b9 src]$ make
+ ...
+ Creating build/annepro2-shine.hex
+ Creating build/annepro2-shine.bin
+ Creating build/annepro2-shine.dmp
+
+ text data bss dec hex filename
+ 7596 52 8136 15784 3da8 build/annepro2-shine.elf
+ Creating build/annepro2-shine.list
+
+ Done
+
+
+Or even something like:
+
+ docker run --rm -it -u "$(id -u):$(id -g)" -w /src -v "/path/to/AnnePro2-Shine:/src" annepro2-build make
+ docker run --rm -it -u "$(id -u):$(id -g)" -w /src -v "/path/to/qmk_firmware:/src" annepro2-build make
+
+Up to you.
+
+[OpenAnnePro]: https://openannepro.github.io/