aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)Author
2018-12-12Add standard definitions for ALGR and KC_ALGR (#4389)Gravatar Konstantin Đorđević
* Add standard ALGR defition, remove (re)definitions from language files * Use ALGR(kc) consistently in ALTGR(kc) aliases * Non-Nordic keymaps should not use NO_ALGR * Add standard KC_ALGR definition * Update docs with ALGR and KC_ALGR * Update SS_ALGR and ALGR_T aliases
2018-12-11Fix macro docs to be consistent with keyboard template (#4600)Gravatar Drashna Jaelre
2018-12-09docs typo (#4584)Gravatar Ben
2018-12-08Add a better Docker build script + update Dockerfile (#4222)Gravatar Konstantin Đorđević
* 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-12-07Add support for PR and Issue templates to QMK_firmware GitHub (#4494)Gravatar Drashna Jaelre
* 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>
2018-12-06Delete docs/keycode.txt (#4505)Gravatar fauxpark
2018-12-05Re-order feature list in sidebar (#4555)Gravatar Drashna Jaelre
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.
2018-12-03Make ARM Audio max volume configurable (#4540)Gravatar Drashna Jaelre
* 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>
2018-12-02Add sidebar for ZH (#4533)Gravatar Jack Humbert
* 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
2018-12-02Second try at configuring i18n for docsify and gitbook (#4531)Gravatar Jack Humbert
* 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
2018-12-01Add tap_random_base64 and software timer info to Useful Functions doc (#4360)Gravatar Drashna Jaelre
* 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>
2018-11-30Test out i18n of the docs (#4519)Gravatar Jack Humbert
* 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
2018-11-29Typo fix (#4515)Gravatar Paul Massendari
2018-11-28Add Extrakey support for Brightness up/down (#4477)Gravatar Giuseppe Rota
2018-11-27Remove RGB_SMOD alias and replace uses with RGB_MOD (#4319)Gravatar Konstantin Đorđević
2018-11-27Fixed docs/newbs_testing_debugging.md and tmk_core/common/print.hGravatar mtei
2018-11-26Revert "Add support for PR and Issue templates to QMK_firmware GitHub ↵Gravatar Drashna Jaelre
(#4491)" (#4492) This reverts commit b91dfa04e3bad560fb6fe2360dd51fb95d95fcbf.
2018-11-26Add support for PR and Issue templates to QMK_firmware GitHub (#4491)Gravatar Drashna Jaelre
* 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
2018-11-25Keymap FAQ: fix positions of KC_HENK and KC_MHEN for JIS layout (#4482)Gravatar noroadsleft
These keys were previously in each other's positions.
2018-11-23Add EEPROM_RESET keycode to keycodes.md doc (#4473)Gravatar noroadsleft
2018-11-18Allows disabling rgb effects in userspace (#4422)Gravatar Florian Didron
* Allows disabling animations in user space * Describe disabling effects in the docs * Allows disabling individual reactive modes * Adds the list ode defines
2018-11-15Use a single endpoint for HID reports (#3951)Gravatar James Laird-Wah
* 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
2018-11-14Docs: Supporting a keyboard in the QMK Configurator (#4396)Gravatar noroadsleft
* 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
2018-11-14Backlight status functions (#4259)Gravatar Phillip Tennen
* 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
2018-11-14Fixed Unicode Support heading (#4425)Gravatar James Osborn
Previously, Unicode Support heading appeared as the last row in the Swap Hands table.
2018-11-13Docs: Fix descriptions of KC_INT1 and KC_INT3Gravatar KOBAYASHI Daisuke
2018-11-13Remove duplicate row from Available functions table in i2c_driver doc (#4416)Gravatar Junya Ogura
2018-11-12Fixed incorrect link to feature_combo.md in features.md docs file. Was ↵Gravatar TheOneTrueTrench
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)
2018-11-12Make sure that avr-gcc@7 gets linked into the path on MacOS.Gravatar Michael Kaylan
2018-11-10I2C driver docs (#4298)Gravatar yiancar
* 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
2018-11-07Configurable Rainbow Swirl range (#4376)Gravatar Frank Tackitt
* 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
2018-11-06Improve wording, punctuation and capitalization in newbs_getting_started ↵Gravatar Konstantin Đorđević
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
2018-11-06Update Features page to reflect all of the features linked in the ↵Gravatar Drashna Jaelre
sidebar/summary
2018-11-06fix example to reflect caveatGravatar Drashna Jaelre
2018-11-06Add EEPROM_RESET keycode to core code (#4234)Gravatar Drashna Jaelre
* Add EEPROM Reset keycode * Add keycode to docs * Move EEPROM Reset code to the end of the enum * Cleanup and naming change
2018-11-06Clarify the Mod Tap defines in documentation (#4352)Gravatar Drashna Jaelre
* 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>
2018-11-06Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)Gravatar Konstantin Đorđević
* Remove ALTG(kc) as it's misleading and is not actually AltGr * Add temporary alias for ALGR in keyboards/planck/keymaps/pevecyan/keymap.c
2018-11-03Instructions on how to flash via STM32 bootloader (#4316)Gravatar Michael Pio
* Add instructions on flashing ARM keyboards with default STM32 bootloader * fixed typo; added note suggestion to step 4
2018-11-02Add support for Atmega32A to pin declarations and universal matrix (#4015)Gravatar Jack Humbert
* 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
2018-10-30Update feature_bootmagic.md (#4290)Gravatar Leah
Fix typo
2018-10-27Add Bootmagic Lite to QMK (#4215)Gravatar Drashna Jaelre
* 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
2018-10-27Docs: Add references to One Shot functions, and clean up formatting (#4189)Gravatar Drashna Jaelre
* Docs: Add references to One Shot functions, and clean up formatting * Update PR based on @mechmerlin's recommendations
2018-10-27Add caveat for basic keycodes in Tap Dance docsGravatar Drashna Jaelre
2018-10-27Add key caveat to combos docGravatar Drashna Jaelre
2018-10-26add better exampleGravatar Jack Humbert
2018-10-26add support for encoders to coreGravatar Jack Humbert
2018-10-26Fix incorrect doctoring in feature.backlight.md (#4244)Gravatar Phillip Tennen
I'm guessing someone deleted a row at some point in the past, but I didn't blame it.
2018-10-24Fix syntax for windowsGravatar Drashna Jaelre
2018-10-22Update the installation script PR (#4167)Gravatar Drashna Jaelre
* Update docs to use qmk_install * Update Vagrantfile to use qmk_install
2018-10-22Add caveats for shifted characters (#4192)Gravatar Drashna Jaelre
* 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
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-12-29 03:25:08 +0000