summaryrefslogtreecommitdiffstats
path: root/docs/getting_started_build_tools.md
Commit message (Collapse)AuthorAgeFilesLines
* Add a better Docker build script + update Dockerfile (#4222)Konstantin Đorđević2018-12-081-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
* Make sure that avr-gcc@7 gets linked into the path on MacOS.Michael Kaylan2018-11-121-0/+1
|
* Update the installation script PR (#4167)Drashna Jaelre2018-10-221-1/+1
| | | | | | * Update docs to use qmk_install * Update Vagrantfile to use qmk_install
* Minor updates to build tools docs revised (#4195)Dylan Khor2018-10-221-3/+3
| | | | | | * add initial khord iris keymap * correct path of windows qmk install script
* Updates docs - planck 6 and macos instructions (#4201)Colin T.A. Gray2018-10-221-0/+1
| | | | | | * add note about how to install rev6 (dfu-util) * include instructions on installing dfu-util on macOS
* Instruct macos users to use avr-gcc@7 (#3337)Evan Travers2018-07-071-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.
* added some helpful notes to the documentation (#2981)GreenShadowMaker2018-05-221-0/+2
|
* Fixed formatting for Fedora exampleferbie2018-02-231-0/+1
|
* ergobox -> ergodoxJose Pablo Mora2018-02-231-1/+1
|
* Minor updates to docs (#2406)Ben Hilburn2018-02-191-1/+4
| | | | | | * [docs/] Cleaning up some language to make it more clear. * [docs/] Adding instructions for installing deps on RH / Fedora.
* macOS also requires avrdudeRickard von Essen2018-01-021-0/+1
|
* Trim trailing whitespacefauxpark2017-12-091-3/+3
|
* Fix some of the more obvious typosfauxpark2017-12-091-1/+1
|
* Convert all headings to Title Casefauxpark2017-12-091-3/+3
|
* Improvements to documentation (#1919)Arialdo Martini2017-11-011-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
* Make arguments redo, subproject elimination (#1784)Jack Humbert2017-10-141-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
* Add shell.nix for NixOS usersLukas Werling2017-09-251-1/+9
|
* Update mac guide (#1665)Will Jiang2017-09-061-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.
* Doc updates from going through every fileskullY2017-08-161-1/+1
|
* Overhaul the Getting Started section and add a FAQ sectionskullY2017-08-161-0/+123
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-26 01:55:20 +0000