summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs typo (#4584)Ben2018-12-091-1/+1
|
* 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
* Add support for PR and Issue templates to QMK_firmware GitHub (#4494)Drashna Jaelre2018-12-073-0/+45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add support document * Add Bug Report * Add GitHub Pull Request Template * Feature request issue template * Touch up feature request template * Add 'other issues' template * move support doc * Minor tweaks * More minor tweaks * Spleeling fix Co-Authored-By: drashna <drashna@live.com> * CapiTALization fIXes Co-Authored-By: drashna <drashna@live.com> * Use new issue URL Co-Authored-By: drashna <drashna@live.com> * Add blanck issue template * Update the PR template * Formatting and additional changes * Update docs/support.md Co-Authored-By: drashna <drashna@live.com>
* Delete docs/keycode.txt (#4505)fauxpark2018-12-061-263/+0
|
* Re-order feature list in sidebar (#4555)Drashna Jaelre2018-12-052-2/+2
| | | Specifically, moved the shifted keycodes to the top of the 'Feature' list, so it's more visible. This way, all of the keycodes are at the top of the list, rather than having the shifted keys at the bottom, so they should be easier to find since they're all in one place.
* Make ARM Audio max volume configurable (#4540)Drashna Jaelre2018-12-031-0/+7
| | | | | | | | | | | | * Make ARM Audio max volume configurable * Update docs/feature_audio.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_audio.md Co-Authored-By: drashna <drashna@live.com>
* Add sidebar for ZH (#4533)Jack Humbert2018-12-022-32/+99
| | | | | | | | | | | | | | | | | | | | | | | | | | | * add zh-cn readme * edit readme * Round 1 of edits - Mandarin translation of QMK products is off, best to use the English name. - Fix some terminology and grammar. * trying re-translating the first paragraph * add fallback langurages * Create LANGS.md * Rename docs/zh-cn/README.md to docs/zh/README.md * Update LANGS.md * Update index.html * Delete README.md * add sidebar for zh
* Second try at configuring i18n for docsify and gitbook (#4531)Jack Humbert2018-12-023-1/+38
| | | | | | | | | | | | | | | | | | | | | | | * add zh-cn readme * edit readme * Round 1 of edits - Mandarin translation of QMK products is off, best to use the English name. - Fix some terminology and grammar. * trying re-translating the first paragraph * add fallback langurages * Create LANGS.md * Rename docs/zh-cn/README.md to docs/zh/README.md * Update LANGS.md * Update index.html
* Add tap_random_base64 and software timer info to Useful Functions doc (#4360)Drashna Jaelre2018-12-012-17/+21
| | | | | | | | | | | | | | | | * Update docs * Add security caveat Co-Authored-By: drashna <drashna@live.com> * Wordsmithing Co-Authored-By: drashna <drashna@live.com> * Update docs/ref_functions.md Co-Authored-By: drashna <drashna@live.com>
* Test out i18n of the docs (#4519)Jack Humbert2018-11-301-0/+32
| | | | | | | | | | | | | * add zh-cn readme * edit readme * Round 1 of edits - Mandarin translation of QMK products is off, best to use the English name. - Fix some terminology and grammar. * trying re-translating the first paragraph
* Typo fix (#4515)Paul Massendari2018-11-291-1/+1
|
* Add Extrakey support for Brightness up/down (#4477)Giuseppe Rota2018-11-283-0/+6
|
* Remove RGB_SMOD alias and replace uses with RGB_MOD (#4319)Konstantin Đorđević2018-11-271-2/+0
|
* Fixed docs/newbs_testing_debugging.md and tmk_core/common/print.hmtei2018-11-271-1/+1
|
* Revert "Add support for PR and Issue templates to QMK_firmware GitHub ↵Drashna Jaelre2018-11-261-43/+0
| | | | | (#4491)" (#4492) This reverts commit b91dfa04e3bad560fb6fe2360dd51fb95d95fcbf.
* Add support for PR and Issue templates to QMK_firmware GitHub (#4491)Drashna Jaelre2018-11-261-0/+43
| | | | | | | | | | | | | | | | * Add support document * Add Bug Report * Add GitHub Pull Request Template * Feature request issue template * Touch up feature request template * Add 'other issues' template * move support doc
* Keymap FAQ: fix positions of KC_HENK and KC_MHEN for JIS layout (#4482)noroadsleft2018-11-251-2/+2
| | | These keys were previously in each other's positions.
* Add EEPROM_RESET keycode to keycodes.md doc (#4473)noroadsleft2018-11-231-12/+13
|
* Allows disabling rgb effects in userspace (#4422)Florian Didron2018-11-181-0/+24
| | | | | | | | | | * Allows disabling animations in user space * Describe disabling effects in the docs * Allows disabling individual reactive modes * Adds the list ode defines
* Use a single endpoint for HID reports (#3951)James Laird-Wah2018-11-151-0/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Unify multiple HID interfaces into one This reduces the number of USB endpoints required, which frees them up for other things. NKRO and EXTRAKEY always use the shared endpoint. By default, MOUSEKEY also uses it. This means it won't work as a Boot Procotol mouse in some BIOSes, etc. If you really think your keyboard needs to work as a mouse in your BIOS, set MOUSE_SHARED_EP = no in your rules.mk. By default, the core keyboard does not use the shared endpoint, as not all BIOSes are standards compliant and that's one place you don't want to find out your keyboard doesn't work.. If you are really confident, you can set KEYBOARD_SHARED_EP = yes to use the shared endpoint here too. * unify endpoints: ChibiOS protocol implementation * fixup: missing #ifdef EXTRAKEY_ENABLEs broke build on AVR with EXTRAKEY disabled * endpoints: restore error when too many endpoints required * lufa: wait up to 10ms to send keyboard input This avoids packets being dropped when two reports are sent in quick succession (eg. releasing a dual role key). * endpoints: fix compile on ARM_ATSAM * endpoint: ARM_ATSAM fixes No longer use wrong or unexpected endpoint IDs * endpoints: accommodate VUSB protocol V-USB has its own, understandably simple ideas about the report formats. It already blasts the mouse and extrakeys through one endpoint with report IDs. We just stay out of its way. * endpoints: document new endpoint configuration options * endpoints: respect keyboard_report->mods in NKRO The caller(s) of host_keyboard_send expect to be able to just drop modifiers in the mods field and not worry about whether NKRO is in use. This is a good thing. So we just shift it over if needs be. * endpoints: report.c: update for new keyboard_report format
* Docs: Supporting a keyboard in the QMK Configurator (#4396)noroadsleft2018-11-143-0/+197
| | | | | | | | | | | | | | | | | | | | | | * Docs: Configurator Support * Minor updates * Updated keyboard.h example to use #pragma once per @drashna https://github.com/qmk/qmk_firmware/pull/4396#discussion_r232140934 * Add link to doc under Reference section Added to _sidebar.md and _summary.md * Changed doc title; minor tweaks Re-titled the doc as "Supporting Your Keyboard in QMK Configurator". Made some minor changes to the keyboard.h examples. * Added tags object to JSON example
* Backlight status functions (#4259)Phillip Tennen2018-11-141-8/+11
| | | | | | | | | | | | | | | | | | * add functions to set specific backlight state * add function to query backlight state * update documentation with new backlight functions * Update tmk_core/common/backlight.c Co-Authored-By: codyd51 <phillip.ennen@gmail.com> * Update tmk_core/common/backlight.h Co-Authored-By: codyd51 <phillip.ennen@gmail.com> * update docs for is_backlight_enabled() name change
* Fixed Unicode Support heading (#4425)James Osborn2018-11-141-0/+1
| | | Previously, Unicode Support heading appeared as the last row in the Swap Hands table.
* Docs: Fix descriptions of KC_INT1 and KC_INT3KOBAYASHI Daisuke2018-11-132-4/+4
|
* Remove duplicate row from Available functions table in i2c_driver doc (#4416)Junya Ogura2018-11-131-1/+0
|
* Fixed incorrect link to feature_combo.md in features.md docs file. Was ↵TheOneTrueTrench2018-11-121-1/+1
| | | | linked to feature_combos.md, but _sidebar.md, _summary.md, and config_options.md all link to feature_combo.md. Assuming that it should not be pluralized. (#4411)
* Make sure that avr-gcc@7 gets linked into the path on MacOS.Michael Kaylan2018-11-122-1/+2
|
* I2C driver docs (#4298)yiancar2018-11-103-0/+85
| | | | | | | | | | | | | | | | | | | | | | | | | * I2C driver docs - Added I2C driver docs. - Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world. * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * GPIO release fix
* Configurable Rainbow Swirl range (#4376)Frank Tackitt2018-11-071-0/+1
| | | | | | | | | | | | | | * Configurable Rainbow Swirl range This allows tweaking of the rainbow effect to get different effects on keyboards with varied LED layouts. We found the value 1950 works on the RGBKB.net Sol to get a cool striped effect across the keyboard. * Document RGBLIGHT_RAINBOW_SWIRL_RANGE * Better wording for the documentation
* Improve wording, punctuation and capitalization in newbs_getting_started ↵Konstantin Đorđević2018-11-061-40/+38
| | | | | | | | | | | | | | | | | | | | | | guide (#4342) * Improve wording, punctuation and capitalization in newbs_getting_started guide Also add some links * Update example build command output Co-Authored-By: vomindoraan <vomindoraan@gmail.com> * Replace occurrences of "layout" with "keymap" Co-Authored-By: MechMerlin <30334081+mechmerlin@users.noreply.github.com> * Explicitly instruct users to open an MSYS2 MinGW 64-bit terminal * MSYS2 Console → MSYS2 MinGW * Replace thin spaces with regular spaces
* Update Features page to reflect all of the features linked in the ↵Drashna Jaelre2018-11-061-0/+4
| | | | sidebar/summary
* fix example to reflect caveatDrashna Jaelre2018-11-061-5/+5
|
* Add EEPROM_RESET keycode to core code (#4234)Drashna Jaelre2018-11-061-12/+13
| | | | | | | | | | * Add EEPROM Reset keycode * Add keycode to docs * Move EEPROM Reset code to the end of the enum * Cleanup and naming change
* Clarify the Mod Tap defines in documentation (#4352)Drashna Jaelre2018-11-062-19/+52
| | | | | | | | | | | | | | | | | | | | | | | | | | * Fix up Mod Tap settings keys * Change link names * permissive hold wordsmith Co-Authored-By: drashna <drashna@live.com> * ignore mod tap wordsmithing Co-Authored-By: drashna <drashna@live.com> * grammar fix Co-Authored-By: drashna <drashna@live.com> * wordsmithing Co-Authored-By: drashna <drashna@live.com> * word smithing Co-Authored-By: drashna <drashna@live.com>
* Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)Konstantin Đorđević2018-11-062-2/+0
| | | | | | * Remove ALTG(kc) as it's misleading and is not actually AltGr * Add temporary alias for ALGR in keyboards/planck/keymaps/pevecyan/keymap.c
* Instructions on how to flash via STM32 bootloader (#4316)Michael Pio2018-11-031-4/+27
| | | | | | * Add instructions on flashing ARM keyboards with default STM32 bootloader * fixed typo; added note suggestion to step 4
* Add support for Atmega32A to pin declarations and universal matrix (#4015)Jack Humbert2018-11-021-1/+1
| | | | | | | | | | | | | | | | | | * add computed pins from mcu type * update for atmega32a * doc typo * add atmega16 chips, link to references * remove avr include from config * exclude assembler in config.h includes * consolodate options, add 646 * fix typo in pindef
* Update feature_bootmagic.md (#4290)Leah2018-10-301-1/+1
| | | Fix typo
* Add Bootmagic Lite to QMK (#4215)Drashna Jaelre2018-10-271-1/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Preliminary additon of bootmagic lite functionality * Cleanup code * Clean up bootmagic code * Add documentation and clean up code * Make 'lite' an option for BOOTMAGIC_ENABLE * Update Templates with note about Bootmagic Lite option * Detect Debounce variable * Make sure debounce is a non-zero number * Capitalize Bootmagic * Capitalize bootmagic * Update wording * Re-add EEPROM reset, by popular demand And add eeprom-less version to drashna userspace for his sanity * Fix spacing * Set BOOTMAGIC_ENABLE to use full/lite/off And default yes to "full" for compatibility * Add Bootmagic lite info to templates * Remove text from makefiles * Cleanup of makefile * mention yes in bootmagic docs * Wordsmitthing the docs * Fix white spaces * Readd default bootmagic setting, because it's necessary
* Docs: Add references to One Shot functions, and clean up formatting (#4189)Drashna Jaelre2018-10-271-5/+12
| | | | | | * Docs: Add references to One Shot functions, and clean up formatting * Update PR based on @mechmerlin's recommendations
* Add caveat for basic keycodes in Tap Dance docsDrashna Jaelre2018-10-271-0/+2
|
* Add key caveat to combos docDrashna Jaelre2018-10-271-0/+1
|
* add better exampleJack Humbert2018-10-261-2/+9
|
* add support for encoders to coreJack Humbert2018-10-263-0/+43
|
* Fix incorrect doctoring in feature.backlight.md (#4244)Phillip Tennen2018-10-261-1/+1
| | | I'm guessing someone deleted a row at some point in the past, but I didn't blame it.
* Fix syntax for windowsDrashna Jaelre2018-10-241-1/+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
* Add caveats for shifted characters (#4192)Drashna Jaelre2018-10-222-6/+18
| | | | | | | | | | | | | | | | * Add caveats for shifted characters And some formatting and grammar corrections. Closes #1037 * Fix spelling of remote * Fix spelling error * Remote not Remove * Remote not Remove
* Update hardware config warnings to be more accurateDrashna Jaelre2018-10-221-1/+1
| | | | Closes #3565
* 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
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-01 02:25:04 +0000