]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Merge pull request #530 from sethbc/master
authorJack Humbert <jack.humb@gmail.com>
Fri, 22 Jul 2016 01:01:35 +0000 (21:01 -0400)
committerGitHub <noreply@github.com>
Fri, 22 Jul 2016 01:01:35 +0000 (21:01 -0400)
Misc. fixes from sethbc

1  2 
readme.md

diff --cc readme.md
index bdea197f55e9fbf304a8f812bab93c8388f713e5,b55659c7a767cb35301201b6051577bd1b8fdd1b..7c6a84795c7f5ce4daa3c5408382828d1acfad08
+++ b/readme.md
@@@ -75,23 -75,8 +75,23 @@@ 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).
+ 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](doc/VAGRANT_GUIDE.md).
  
  ## Verify Your Installation
  1. If you haven't already, obtain this repository ([https://github.com/jackhumbert/qmk_firmware](https://github.com/jackhumbert/qmk_firmware)). You can either download it as a zip file and extract it, or clone it using the command line tool git or the Github Desktop application.