summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Add flake8 to our test suite and fix all errors (#7379)skullydazed2019-11-201-0/+32
| | | | | | * Add flake8 to our test suite and fix all errors * Add some documentation
* [Docs] Start of German translation of documentation (#6909)kuchosauronad02019-11-209-0/+885
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Initial commit * Fix links so that they point to the german translation * minor changes to the wording of some sentences * correctly capitalize second person pronouns * Fix links so that they point to the german translation * minor changes to the wording of some sentences * correctly capitalize second person pronouns * Translate newbs_learn_more_resources.md * Clear up some phrases * Add newbs_building_firmware.md, fix spelling * Add newbs_building_firmware.md, fix spelling * Update docs/de/_summary.md Danke * Update docs/de/README.md * Update docs/de/_summary.md Ich wollte es kuerzer halten damit die Navigationsleiste nicht zu breit wird, aber das ist halt die deutsche Sprache :) * Update docs/de/newbs.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs.md * Update docs/de/newbs.md * Update docs/de/newbs.md * Update docs/de/README.md * Update docs/de/README.md * Update docs/de/README.md * Update docs/de/README.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Apply suggestions from code review * Add translation of newbs_flashing.md * Apply suggestions from code review Danke * Add translation of Zadig-guide * Translate newbs_testing_debugging.md to german Co-Authored-By: Max Rumpf <max.rumpf1998@gmail.com> Co-Authored-By: geisterfurz007 <geisterfurz007@users.noreply.github.com>
* fix feature_advanced_keycodes.md's link (#7421)Takeshi ISHII2019-11-201-1/+1
| | | | | | | | | | | docs/feature_advanced_keycodes.md has: ``` [Tap Dance](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) ``` change to: ``` [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) ```
* Fix typo and code indentation (#7410)Mihai Olteanu2019-11-191-2/+2
|
* [Docs] Fix Japanese country flag (#7407)shela2019-11-191-1/+1
|
* [Docs] Modified the description about setting debug_enable in ↵Takeshi ISHII2019-11-171-1/+1
| | | | `docs/faq_debug.md`. (#7394)
* Doc fix to conform with #7221 (#7392)Erovia2019-11-171-5/+3
|
* [Docs] Explain Tap Dance interruption (#5520)Robert Akhmerov2019-11-161-0/+2
|
* Add CLI command for flashing a keyboardjorgemanzo2019-11-151-0/+24
| | | | | | | | A new CLI subcommand was added, flash, which behaves very similar to the already present compile CLI comamnd, but with the added ability to target a bootloader. The command is used like so: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename]. A -kb <keyboard> and -km <keymap> is expected, or a configurator export JSON filename. A bootloader can be specified using -bl <target>, and if left unspecified, the target is assumed to be :flash. -bl can be used to list the available bootloaders. If -km <keymap> is provided, but no -kb <keyboard>, then a message is printed suggesting the user to run qmk list_keyboards.
* Improvements to Solenoid feature (#7369)Drashna Jaelre2019-11-151-5/+9
| | | | | | | | | | * Error out when Solenid pin is not defined Instead of defaulting to a (literally) random pin, error out instead. Because this pin may be used, or because that pin may not be exposed, or may not exist. * Remove 'SOLENOID_ACTIVE' setting since it's not used * Update documentation
* [Docs] Japanese translation of docs/ja/newbs_best_practices.md (#7337)Takeshi ISHII2019-11-148-51/+153
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Mark same as in new document #7231 * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * comment out the same marks * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs.md, docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/*.md's comment * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md Co-Authored-By: shela <shelaf@users.noreply.github.com>
* [Docs] Encourage newbs to not download the repo as a zip (#7353)fauxpark2019-11-143-31/+1
| | | | | | * Encourage newbs to not download the repo as a zip * Tweak wording and remove Russian translation of deprecated Vista+ instructions
* Update debounce docs (#7355)Drashna Jaelre2019-11-141-5/+5
|
* Add cli convert subcommand, from raw KLE to JSON (#6898)Cody Bender2019-11-121-0/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add initial pass at KLE convert * Add cli log on convert * Move kle2xy, add absolute filepath arg support * Add overwrite flag, and context sensitive conversion * Update docs/cli.md * Fix converter.py typo * Add convert unit test * Rename to kle2qmk * Rename subcommand * Rename subcommand to kle2json * Change tests to cover rename * Rename in __init__.py * Update CLI docs with new subcommand name * Fix from suggestions in PR #6898 * Help with cases of case sensitivity * Update cli.md * Use angle brackets to indicate required option * Make the output text more accurate
* Japanese translation of newbs.md and related documents. (#7300)Takeshi ISHII2019-11-1110-0/+1078
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add docs/ja/newbs.md * Update docs/ja/newbs.md * Updated newbs.md * Updated newbs.md * add docs/ja/newbs_learn_more_resources.md * Update docs/ja/newbs.md * update link info 他人まかせ :-) * add docs/ja/newbs_testing_debugging.md * Update docs/ja/newbs_testing_debugging.md * Update docs/ja/newbs_testing_debugging.md * add docs/ja/newbs_building_firmware.md * update docs/ja/newbs_building_firmware.md * Update docs/ja/newbs_testing_debugging.md * Update docs/ja/newbs_building_firmware.md * Update docs/ja/newbs_building_firmware.md * Japanese translation of docs/newbs_getting_started.md * renamed: docs/QMK入門.md -> docs/ja/newbs_getting_started.md * update docs/ja/newbs_getting_started.md * add ja/newbs_best_practices.md There are no plans to translate this file. With the completion of #7231, I will open a new PR. * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * add docs/ja/newbs_flashing.md * add docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * update docs/ja/newbs_flashing.md * change original log format * update docs/ja/newbs_flashing.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * copy docs/_langs.md and docs/index.html from #7248 Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: takashiski <takashiskibb@gmail.com> Co-Authored-By: Takuya Urakawa <urkwtky@gmail.com>
* Unify RGB and RGBW commands (#7297)Drashna Jaelre2019-11-091-2/+2
| | | | | | | | | | | | | | | | | | | | | | * Fix unicode in comments Co-Authored-By: fauxpark <fauxpark@gmail.com> * Remove separate RGBW implementation for a unified function * Set White to 0 in RGBW LEDs This is just to get this working, later, proper brightness can be handled elsewhere. * Use us instead of nanoseconds(?) since it renders correctly on web * Remove RGBW function from arm/ws2812.h * Remove RGBW function from arm/ws2812.c * Formatting changes * Add doc info
* [Doc] Tidy up compatible MCUs docs (#7295)fauxpark2019-11-082-18/+30
| | | | | | | | | | | | * Tidy up compatible MCUs docs * ARM chips should have USB * 32KB soft lower limit applies to ARM as well * NXP is the manufacturer name, not Kinetis * Units
* [Docs] Create RU ver of getting_started_github (#7225)Gregory Gubarev2019-11-081-0/+58
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Create RU ver of getting_started_github * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update * Updated first frase * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Updated Co-Authored-By: Nikita Titov <nekit94-08@mail.ru> Co-Authored-By: nabokovas <bbkv@bk.ru>
* ARM - ws2812 bitbang (#7173)Joel Challis2019-11-074-5/+14
| | | | | | | | | | | | | | | | | | | | * Initial ARM bitbang ws2812 driver * Unify chibios platform to run rgblight_task * Remove 'avr only' comments from ws2812 docs * Remove 'avr only' comments from ws2812 docs * Unify chibios platform to run rgblight_task - review comments * Remove debug flags from keymap * Add comments from review * Add defines for STM32L0XX * Attempt to get arm ws2812 working on multiple gcc versions
* New and improved lock LED callbacks (#7215)fauxpark2019-11-061-27/+69
| | | | | | | | | | * New and improved lock LED callbacks * Include stdbool * Update documentation * Use full function signatures and add keyboard-level example
* [Core] Convert Dynamic Macro to a Core Feature (#5948)Drashna Jaelre2019-11-042-36/+49
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Convert Dynamic Macro to a Core Feature This imports the code from Dynamic Macro into the core code, and handles it, as such. This deprecates the old method but does not remove it, for legacy support. This way, no existing user files need to be touched. Additionally, this reorganizes the documentation to better reflect the changes. Also, it adds user hooks to the feature so users can customize the existing functionality. Based heavily on and closes #2976 * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Cleanup based on feedback * Add short-form keycodes and document them - add short-form keycodes to quantum/quantum_keycodes.h - document the new aliases in docs/feature_dynamic_macros.md * Add Dynamic Macros section and keycodes to docs/keycodes.md * Make anti-nesting optional * Add documentation for DYNAMIC_MACRO_NO_NESTING option * Fix Merge artifacts * Fix formatting typo in docs Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Remove DYNAMIC_MACRO_RANGE as it's not needed * Fix includes and layer var type
* [Core] Add short form LTO_ENABLE (#7259)Drashna Jaelre2019-11-041-1/+2
| | | For drashna's sanity's sake
* [Docs] Create RU ver getting_started_getting_help (#7227)Gregory Gubarev2019-11-041-0/+15
| | | | | | | | | | | * Create RU ver getting_started_getting_help * uodate RU ver of getting_started_getting_help * Update docs/ru-ru/getting_started_getting_help.md Co-Authored-By: nabokovas <bbkv@bk.ru> Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
* Adds raw write functions to the OLED driver (#7237)Thomas Baart2019-11-031-0/+6
| | | | | | * Added oled_write_raw and oled_write_raw_P functions to the OLED driver * Added oled_write_raw method calls to feature_oled_driver.md
* Smallish overhaul of Auto-Shift feature (#6067)Drashna Jaelre2019-11-031-10/+10
| | | | | | | | | | | | | * Fix edge case when using One Shot Layer with Auto Shift, and it not triggering the cleanup * Remove junk code (no longer used) * Replace `(un)register_code` calls with `tap_code` where appropriate * Fixed up Switch check to be more readable (less verbose) * Simplified modifier check (if it comes back non-zero, there are mods) * Add additional function calls for autoshift settings * Made all variables static, since there are function calls to get their status * Fixed up documentation * Re-add special characters that were missed * formatting pass
* French translation - FAQ section (#6995)Xavier Hahn2019-11-0325-23/+735
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Translated faq.md and added all other files (copy from English) * Translated driver_installation_zadig.md in French * Translated faq_build.md in French * Translated faq_debug in French * Translateed faq_general.md in French * Translated first part of faq_keymap.md * Renamed docs/fr-FR folder to docs/fr-fr * Finished translation of faq_keymap.md * Update faq_build.md * Review (#3) * Review * Update docs/fr-fr/faq_keymap.md * Update docs/fr-fr/faq_debug.md * Fix some PR comments Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch> Co-Authored-By: Wermeille Bastien <bastien.wermeille@gmail.com>
* Use task driven PWM for CTPC until ARM can provide automatic configuration ↵Joel Challis2019-11-021-0/+10
| | | | | | | | (#6928) * Use task driven PWM for CTPC until ARM can provide automatic configuration * Update CTPC docs to cover backlight
* Initial migration of software PWM backlight (#6709)Joel Challis2019-11-021-44/+87
| | | | | | | | | | | | * Initial migration of software PWM backlight * First pass at backlight driver docs * Correct driver name in docs * Run backlight_task when using BACKLIGHT_PINS * Resolve backlight docs TODOs
* correct description (#7240)umi2019-11-021-1/+1
|
* [Docs] Add Spanish translation for hardware documentation (#7161)michizhou2019-10-314-0/+374
| | | | | | | | | | | | | * Add Spanish translation for hardware documentation * Finished Spanish translations for hardware docs * Resolved errors in Spanish page translations * Corrected misspelled folder name in documentation Co-Authored-By: Karey Higuera <karey.higuera@gmail.com> Co-Authored-By: José Ignacio Amelivia Santiago <ohcan2@gmail.com>
* [Docs] Spanish translation (#7068)José Ignacio Amelivia Santiago2019-10-3113-1/+1102
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add all translation docs to translating.md * Adding Spanish folder and README.md * Adding Spanish to the langs file * Adding a Spanish summary file * Small corrections on the Spanish README file * Adding Spanish newbs.md * Translate some newbs documentation * Adding the translated newbs getting started file * Adding the building firmware file * Adding a translated building firmware with configurator file * Adding the flashing guide * Adding the newbs_testing_debugging file * Apply suggestions from code review * QMK Configurator -> Configurador QMK Co-Authored-By: Karey Higuera <karey.higuera@gmail.com>
* [Docs] Add he-IL (Hebrew) Translation (#7001)Guy Khmelnitsky2019-10-3114-0/+531
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add he-IL (Hebrew) Translation * Add Hebrew to SUMMARY * Try RTL * Add RTL text * Lowercase folder names * Update lowercase folder in Summary * Adding getting_started_introdu