diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-07-21 20:58:39 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-21 20:58:39 -0400 |
| commit | 2bed835a331101c1ad70e97f8ce40bd85f546949 (patch) | |
| tree | a43258e083941262134a10459d6901c0d32ddce6 | |
| parent | fc9f12864859dffe7a50dd509013ec916d338fd8 (diff) | |
| parent | aa2a79bbfa5e5134fc83daf5732ca4774edf2dc2 (diff) | |
Merge pull request #525 from edasque/master
Added Docker as a simple way to build firmwares
| -rw-r--r-- | Dockerfile | 28 | ||||
| -rw-r--r-- | readme.md | 15 |
2 files changed, 43 insertions, 0 deletions
diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000000..96ace4ec6b --- /dev/null +++ b/Dockerfile @@ -0,0 +1,28 @@ +FROM debian:jessie +MAINTAINER Erik Dasque <erik@frenchguys.com> + +RUN apt-get update +RUN apt-get install --no-install-recommends -y build-essential \ + gcc \ + unzip \ + wget \ + zip \ + gcc-avr \ + binutils-avr \ + avr-libc \ + dfu-programmer \ + dfu-util \ + gcc-arm-none-eabi \ + binutils-arm-none-eabi \ + libnewlib-arm-none-eabi \ + git + +RUN apt-get clean +RUN rm -rf /var/lib/apt/lists/* + +ENV keyboard=ergodox_ez +ENV keymap=default + +VOLUME /qmk +WORKDIR /qmk +CMD make clean ; make keyboard=${keyboard} keymap=${keymap}
\ No newline at end of file @@ -75,6 +75,21 @@ Debian/Ubuntu example: sudo apt-get update sudo apt-get install gcc-avr avr-libc dfu-programmer +### Docker + +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 command at the root of the QMK folder to build a keyboard/keymap: + +```bash +# You'll run this every time you want to build a keymap +# modify the keymap and keyboard assigment to compile what you want +# defaults are ergodox_ez/default + +docker run -e keymap=gwen -e keyboard=ergodox_ez --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware + +``` + +This will compile the targetted keyboard/keymap and leave it in your QMK directory for you to flash. + ### Vagrant 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). |