aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Dockerfile28
-rw-r--r--readme.md19
2 files changed, 47 insertions, 0 deletions
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 000000000..96ace4ec6
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,28 @@
1FROM debian:jessie
2MAINTAINER Erik Dasque <erik@frenchguys.com>
3
4RUN apt-get update
5RUN apt-get install --no-install-recommends -y build-essential \
6 gcc \
7 unzip \
8 wget \
9 zip \
10 gcc-avr \
11 binutils-avr \
12 avr-libc \
13 dfu-programmer \
14 dfu-util \
15 gcc-arm-none-eabi \
16 binutils-arm-none-eabi \
17 libnewlib-arm-none-eabi \
18 git
19
20RUN apt-get clean
21RUN rm -rf /var/lib/apt/lists/*
22
23ENV keyboard=ergodox_ez
24ENV keymap=default
25
26VOLUME /qmk
27WORKDIR /qmk
28CMD make clean ; make keyboard=${keyboard} keymap=${keymap} \ No newline at end of file
diff --git a/readme.md b/readme.md
index e0dcd5608..7a970eea0 100644
--- a/readme.md
+++ b/readme.md
@@ -75,6 +75,25 @@ Debian/Ubuntu example:
75 sudo apt-get update 75 sudo apt-get update
76 sudo apt-get install gcc-avr avr-libc dfu-programmer 76 sudo apt-get install gcc-avr avr-libc dfu-programmer
77 77
78### Docker
79
80If this is a bit complex for you, Docker might be the turn-key solution you need. After installing [Docker](https://www.docker.com/products/docker), run the following commands at the root of the QMK folder:
81
82```bash
83# You only need to run this once, it'll take a little while
84
85docker build -t qmk .
86
87# and you'll run this every time you want to build a keymap
88# modify the keymap and keyboard assigment to compile what you want
89# defaults are ergodox_ez/default
90
91docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw qmk
92
93```
94
95This will compile the targetted keyboard/keymap and leave it in your QMK directory for you to flash.
96
78### Vagrant 97### Vagrant
79If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [VAGRANT_GUIDE file](VAGRANT_GUIDE.md). 98If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [VAGRANT_GUIDE file](VAGRANT_GUIDE.md).
80 99