summaryrefslogtreecommitdiffstats
path: root/docs/getting_started_build_tools.md
AgeCommit message (Collapse)AuthorFilesLines
2019-04-10Revert "Update build instructions and docker file to download submodules" ↵Konstantin Đorđević1-3/+3
(#5533) * Revert "Update build instructions and Dockerfile to download submodules" This reverts commit 93210547bd1bfbbb1ffd56801bb81af46af350a5. * Update build tools docs based on feedback * Fix bad link in build tools docs
2019-03-30Update build instructions and Dockerfile to download submodulesMikhail Goncharov1-0/+2
2019-03-08getting_started_build_tools: dfu-{util,programmer} now available from arch repoenkore1-3/+1
See https://www.archlinux.org/packages/extra/x86_64/dfu-programmer/
2019-02-15docker_build.sh: Run container in interactive mode (#5088)Konstantin Đorđević1-4/+4
* docker_build.sh: Run container in interactive mode * Add message about QMK Toolbox * Update Docker docs
2019-01-10docs: Add Manjaro/Arch dependencies on getting started page (#2701)Guilherme Lima1-0/+6
* Update getting_started_build_tools.md * Update getting_started_build_tools.md
2018-12-08Add a better Docker build script + update Dockerfile (#4222)Konstantin Đorđević1-11/+14
* Add a Docker build script * Add usage and error messages * Add -r to reads Thanks mechmerlin * Add keyboard:keymap form, improve script * Add target argument, change usage forms in script * Add check for more than 3 args in keyboard:keymap:target form * Change Docker base image to debian, use community repo This matches what qmk_compiler uses (https://github.com/qmk/qmk_compiler/blob/master/Dockerfile#L1). I've removed the maintainer as we now have a community build on Docker Hub (https://hub.docker.com/r/qmkfm/qmk_firmware). This Dockerfile will also be maintained by the community. * Change build command format to keyboard:keymap * Call make directly in container run command * Simplify script, remove 3-arg form * Add COPY to Dockerfile so images are usable in and of themselves Also change WORKDIR from /qmk to /qmk_firmware * Add USB pass-through for Linux and docker-machine hosts * Read directly into variables instead of array * Alphabetically sort dependencies in Dockerfile * Set executable bit on util/docker_build.sh * Update Docker docs * Add warning about Docker on Windows * Expand comment in docs * Check docker-machine exit code instead of string * Only match --help with whole arguments * Make script POSIX-compliant * Convert script indentation to tabs
2018-11-12Make sure that avr-gcc@7 gets linked into the path on MacOS.Michael Kaylan1-0/+1
2018-10-22Update the installation script PR (#4167)Drashna Jaelre1-1/+1
* Update docs to use qmk_install * Update Vagrantfile to use qmk_install
2018-10-22Minor updates to build tools docs revised (#4195)Dylan Khor1-3/+3
* add initial khord iris keymap * correct path of windows qmk install script
2018-10-22Updates docs - planck 6 and macos instructions (#4201)Colin T.A. Gray1-0/+1
* add note about how to install rev6 (dfu-util) * include instructions on installing dfu-util on macOS
2018-07-08Instruct macos users to use avr-gcc@7 (#3337)Evan Travers1-1/+1
If you run `brew install avr-gcc`, you get a version that has compatibility issues with LUFA. I updated the getting started guide for osx, the qmk_install setup script, and added a section to the FAQ for folks like me who accidentally updated avr-gcc past 7.
2018-05-22added some helpful notes to the documentation (#2981)GreenShadowMaker1-0/+2
2018-02-23Fixed formatting for Fedora exampleferbie1-0/+1
2018-02-23ergobox -> ergodoxJose Pablo Mora1-1/+1
2018-02-19Minor updates to docs (#2406)Ben Hilburn1-1/+4
* [docs/] Cleaning up some language to make it more clear. * [docs/] Adding instructions for installing deps on RH / Fedora.
2018-01-02macOS also requires avrdudeRickard von Essen1-0/+1
2017-12-09Trim trailing whitespacefauxpark1-3/+3
2017-12-09Fix some of the more obvious typosfauxpark1-1/+1
2017-12-09Convert all headings to Title Casefauxpark1-3/+3
2017-11-01Improvements to documentation (#1919)Arialdo Martini1-8/+11
* Typo: Github => GitHub * Typo: windows => Windows, docker => Docker, and some punctuations * "QMK Introduction" links to the right file * "Unix" rather than "UNIX", which is a trademark * Directory name is "keyboards", not "keyboard" * "handwired" is a subdirectory of "keyboards" * Punctuation and minor fixes * macOS rather than Mac * Punctuation and other minor fixes * Vagrant Guide links to an existing file * Jun Wako referenced with his name rather than his nickname * Saxon genitive 's outside the link
2017-10-14Make arguments redo, subproject elimination (#1784)Jack Humbert1-2/+2
* redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now
2017-09-25Add shell.nix for NixOS usersLukas Werling1-1/+9
2017-09-06Update mac guide (#1665)Will Jiang1-1/+4
`avr-libc` is no longer, and it's called `avr-gcc` now. https://github.com/osx-cross/homebrew-avr Also you need `gcc-arc-none-eabi` to be able to compile in my experience.
2017-08-16Doc updates from going through every fileskullY1-1/+1
2017-08-16Overhaul the Getting Started section and add a FAQ sectionskullY1-0/+123