diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2016-03-04 21:57:39 -0500 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2016-03-04 21:57:39 -0500 |
| commit | 4a5a2640b984cf90684389d1e58bcefc567c0ca6 (patch) | |
| tree | 675c5ef83c77136827f54641db8dac56af5b5067 | |
| parent | 825626b1f41203f98f757e3a2fe488ee71153adf (diff) | |
| parent | fe7738f2df82db2995857b0fd9e3a965dc3b0d6a (diff) | |
| download | qmk_firmware-4a5a2640b984cf90684389d1e58bcefc567c0ca6.tar.gz qmk_firmware-4a5a2640b984cf90684389d1e58bcefc567c0ca6.zip | |
Merge pull request #179 from NoahAndrews/add-win-linux-instructions
Added Windows and Linux instructions to BUILD_GUIDE.md
| -rw-r--r-- | BUILD_GUIDE.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/BUILD_GUIDE.md b/BUILD_GUIDE.md index 783d00e8d1..4ff25479dd 100644 --- a/BUILD_GUIDE.md +++ b/BUILD_GUIDE.md @@ -3,7 +3,11 @@ ## Build Environment Setup ### Windows -What these instructions look like depends on whether NoahAndrews's setup scripts get merged +1. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**. +2. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location. +3. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/jackhumbert/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer. +4. Right-click on the 1-setup-path-win batch script, select "Run as administrator", and accept the User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up. +5. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete! ### Mac If you're using [homebrew,](http://brew.sh/) you can use the following commands: @@ -21,6 +25,12 @@ You can also try these instructions: 3. Install [DFU-Programmer][dfu-prog]. ### Linux +Install AVR GCC and dfu-progammer with your favorite package manager. + +Debian/Ubuntu example: + + sudo apt-get update + sudo apt-get install gcc-avr dfu-programmer ### 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).
\ No newline at end of file |