diff options
| -rw-r--r-- | Dockerfile | 28 | ||||
| -rw-r--r-- | readme.md | 19 |
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 @@ | |||
| 1 | FROM debian:jessie | ||
| 2 | MAINTAINER Erik Dasque <erik@frenchguys.com> | ||
| 3 | |||
| 4 | RUN apt-get update | ||
| 5 | RUN 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 | |||
| 20 | RUN apt-get clean | ||
| 21 | RUN rm -rf /var/lib/apt/lists/* | ||
| 22 | |||
| 23 | ENV keyboard=ergodox_ez | ||
| 24 | ENV keymap=default | ||
| 25 | |||
| 26 | VOLUME /qmk | ||
| 27 | WORKDIR /qmk | ||
| 28 | CMD make clean ; make keyboard=${keyboard} keymap=${keymap} \ No newline at end of file | ||
| @@ -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 | |||
| 80 | If 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 | |||
| 85 | docker 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 | |||
| 91 | docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw qmk | ||
| 92 | |||
| 93 | ``` | ||
| 94 | |||
| 95 | This will compile the targetted keyboard/keymap and leave it in your QMK directory for you to flash. | ||
| 96 | |||
| 78 | ### Vagrant | 97 | ### Vagrant |
| 79 | If 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). | 98 | If 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 | ||
