summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-01-03Fixed a small typo (#7743)Casper Weiss Bang
2020-01-01[Docs] add japanese translation (faq part) (#7464)umi
* add faq part * add faq part * add faq part * add faq part * add faq part * update for link * update for a punctuation * update files based on comments * restore removed git diff header * correct pathname on git diff header * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update file based on comment * update file based on comment * update file based on comment Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: satt99 <39004890+satt99@users.noreply.github.com>
2019-12-31SPI DMA based RGB Underglow for STM32 (#7674)Joel Challis
* Initial stash of ws2812 spi driver * Update comment, add sync backup plan * Add testing notes to spi ws2812 driver * Align RGBW error messages
2019-12-31[Docs] Update macOS related issues in docs (#7744)Drashna Jaelre
* [Docs] Update macOS related issues in docs * Update faq_build.md * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-30[Docs] remove docs/ja/newbs_best_practices.md (#7739)Takeshi ISHII
'docs/ja/newbs_best_practices.md' has been replaced by 'docs/ja/newbs_git_*.md'.
2019-12-28Japanese translation of docs/newbs_git_*.md (#7689)Takeshi ISHII
* update docs/ja/newbs.md * update docs/ja/_summary.md * Translate docs/newbs_git_best_practices.md into Japanese. * Translate docs/newbs_git_using_your_master_branch.md into Japanese. * Translate docs/newbs_git_resolving_merge_conflicts.md into Japanese. * Translate docs/newbs_git_resynchronize_a_branch.md into Japanese. * Update docs/ja/newbs_git_using_your_master_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_best_practices.md * Update docs/ja/_summary.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_git_resynchronize_a_branch.md * update ja/newbs_learn_more_resources.md * Update docs/ja/newbs_git_resynchronize_a_branch.md * Update docs/ja/newbs_git_resynchronize_a_branch.md Co-Authored-By: shela <shelaf@users.noreply.github.com>
2019-12-27[Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728)Takeshi ISHII
2019-12-27[Docs] Update Japanese translation (#7693)shela
* [Docs] Update translation * Update docs/ja/contributing.md * Update docs/ja/contributing.md Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2019-12-27Fix file encoding for zh-cn/custom_quantum_functions.md (#7665)fauxpark
2019-12-21[Docs] fix docs (#7642)shela
* [Docs] recurse-submodules option is need now * [Docs] `tmk_core` folder is correct * [Docs] fix typo * [Docs] package scope has changed * [Docs] Fix menu differences * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * fix typo Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-18Improve docs "Edit Document" footerfauxpark
2019-12-16[Docs] add japanese translation (basic part) (#7461)umi
* add basic part * update cli * update cli * correct links to ja document * update files based on comments * update for a postpositional particle * update for a punctuation * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2019-12-16Merge pull request #7276 from zvecr/feature/backlight_driver_configJoel Challis
Convert backlight to follow driver rules pattern
2019-12-14Change newbs.md to link to the new newbs_git_best_practices.md instead of ↵Takeshi ISHII
newbs_best_practices.md. (#7633)
2019-12-14Convert backlight to follow driver rules pattern - update docszvecr
2019-12-12[Docs] update git command and directory name of documents (#7619)umi
2019-12-11Remove mbed files (#7605)Joel Challis
* Remove mbed files * Remove mbed files - fix comment * Remove mbed logic blocks
2019-12-11[Docs] Remove some outdated FAQ items (#7607)fauxpark
2019-12-11Use `clock_prescale_set()` from avr-libc (#7540)fauxpark
* Use `clock_prescale_set()` from avr-libc * Remove outdated FAQ info
2019-12-10Update feature support for Proton C (#7596)Duncan Elliot
Added a couple of entries for some features not currently supported on Proton C.
2019-12-10[Docs] Fix docs fallback for pt-br (#7602)fauxpark
2019-12-10[Docs] add README translation in portuguese (#7016)Igor Hideki Trindade
* add README translation in portuguese * add lang in menu * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/README.md * Update docs/pt-br/_summary.md * Update sumary links * Update README Co-Authored-By: Álvaro A. Volpato <alvaro.volpato@usp.br>
2019-12-08fix instructions for oneshot layer handling on key release (#7554)hmkemppainen
* fix instructions for oneshot layer handling on key release * use ONESHOT_OTHER_KEY_PRESSED instead of ONESHOT_PRESSED Co-Authored-By: Drashna Jaelre <drashna@live.com>
2019-12-08Improve support and docs for ADC driver (#7191)fauxpark
* Improve support and docs for ADC driver * Comment ADC channels * Move to Makers and Modders section, and fix usage instructions * Flesh out intro * Superscript 328P note * Fix pin_to_mux LUT * Support USB64/1287 as well * analogReadPin() defaults to 0V mux on invalid pin * Update pinToMux() function documentation * Dot * Accept (some of) the `qmk cformat` changes * Do clang-format properly * More wording tweaks * Link to encoder docs
2019-12-07Minor grammar and filename fixes in docs (#7559)osjuga
Grammar in coding_conventions_c.md and coding_conventions_python.md `rule.mk` to `rules.mk` in feature_haptic_feedback.md and feature_rgb_matrix.md
2019-12-06[Docs] Creating RU version of getting_started_introduction (#7224)Gregory Gubarev
* Creating RU version of getting_started_introduction * Update docs/ru-ru/getting_started_introduction.md Update "предполагается" * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md * Update docs/ru-ru/getting_started_introduction.md Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
2019-12-06[Docs] Create RU ver of becoming_a_qmk_collaborator (#7226)Gregory Gubarev
* Create RU ver of becoming_a_qmk_collaborator * Updated * Updated - collaborator to соавтор * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md * Update docs/ru-ru/becoming_a_qmk_collaborator.md Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
2019-12-06Update getting_started_make_guide.md (#7538)arlenk
* Update getting_started_make_guide.md clarifying that NO_PRINT and USER_PRINT should not be used at the same time. * Update docs/getting_started_make_guide.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
2019-12-05Add short aliases for Magic keycodes (#7541)fauxpark
* Add short alias for `MAGIC_TOGGLE_NKRO` * Add aliases for the other Bootmagic keycodes * Replace long form in default keymaps
2019-12-02[Docs] Restructure of Git Best Practices doc (#7231)James Young
* Add "Resynchronizing an Out-of-Sync Git Branch" doc * Update (Git) Best Practices doc title and filename * Rename Branch Resync doc * fork Best Practices doc into multiple files * Add the doc list to Git Best Practices doc * Update sidebar * Update internal references * Update sidebar - add subsection * Update Your Fork's Master page title * title case on Git Best Practices main doc * ... and in the Resynchronizing a Branch doc * Please read Part 1 I worked really hard on this, okay? * Please use branches, too. * suggestions by mtei * change note about adding multiple files * note that the name given the remote repo is arbitrary * suggestions by fauxpark * Git Best Practices -> Best Git Practices Reads more naturally. * rephrase hint block regarding remote name * rework the resynchronization instructions per mtei * use hint boxes for reference to Part 1 doc I may be addicted to hint boxes. I'm sorry fauxpark. :cry: * add some clarity about the upstream repo * wordsmithing per mtei * restyle the shell code blocks Makes them more consistent to the other docs in this section.
2019-12-02[Docs] add japanese translations (#7454)umi
* for initial commit * for initial commit * for initial commit * Update led_update_kb example (#7451) * Update led_update_kb example * Update comment to explain pin behavior * wordsmith * wordsmithing 2 * Remove CR when computing BOOTLOADER_SIZE. (#7453) * Set up language fallback for docs, and update translation guidelines (#7403) * Set up language fallback for docs, and update translation guidelines * Title Case * Add ID example * Link to emoji flag cheatsheet * Move docs preview section to contributing.md * Point to docs preview in the readme * [Keyboard] Added Cans12er keyboard (#7455) * added cans12er keyboard * updated readme Updated the readme to conform with the provided template from the qmk_firmware githubpage * Update keyboards/cans12er/README.md Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Changed configuration Changed the configuration based on the Change Request from PR #7455 made by github user noroadsleft * [Keyboard] Update ATmega32A readme files to match template (#7462) * Update atmega32a readme files to match template * Update atmega32a readme files to match template - fixes * Apply suggestions from code review * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments * update files based on comments Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-Authored-By: shela <shelaf@users.noreply.github.com>
2019-11-30Add _summary.md for Russian docs with proper language prefix (#7514)fauxpark
2019-11-28Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504)fauxpark
2019-11-28Add shift-to-invert to remaining directional RGB_* keycode pairs (#7484)Manna Harbour
* Add shift-to-invert to remaining directional RGB_* keycode pairs RGB_MODE_FORWARD / RGB_MODE_REVERSE invert their functions when shift is held. This change adds the same capabilities to the remaining directional RGB_* keycode pairs. This improves consistency and provides full RGB control in a keymap containing only one keycode from each pair. * remove redundant variable * fix typo * Fix more typos Flyspell is on now I swear!
2019-11-28Install bootloadHid as part of qmk_install (#7463)Joel Challis
* Install bootloadHid on macos * Install bootloadHid on windows * Highlight bootloadHID is now installed in docs * Update udev rules for bootloadHID * Install bootloadHid on some distros * fix caterina udev filename
2019-11-26Add language prefixes to docs sidebar entries and readmes (#7406)fauxpark
* Add language prefixes to docs sidebar entries and readmes * Remove prefix where it doesn't belong
2019-11-25Send string keycode tweaks (#7471)fauxpark
2019-11-25fix link in docs/translating.md (#7474)Takeshi ISHII
2019-11-23Set up language fallback for docs, and update translation guidelines (#7403)fauxpark
* Set up language fallback for docs, and update translation guidelines * Title Case * Add ID example * Link to emoji flag cheatsheet * Move docs preview section to contributing.md * Point to docs preview in the readme
2019-11-23Update led_update_kb example (#7451)Yan-Fa Li
* Update led_update_kb example * Update comment to explain pin behavior * wordsmith * wordsmithing 2
2019-11-22Allow overriding of all functions in wonderland.c (#7198)Yan-Fa Li
* f * Allow overriding of all functions in wonderland.c - needed for custom LED functions in keymap.c * Example of layer indication via LEDs optimize * Use newer led_update_kb and led_update_user hooks - these allow overriding without use of __attribute((weak))__ * Update led documentation a bit - clarify some of the wording around how to use led_update_user * Update led_update_user example * Update audio example to be complete * trailing spaces smh * spaces * spaces * smh * Less code is good * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/custom_quantum_functions.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-11-21[Docs] Update japanese translation of newbs.md and related documents. (#7431)Takeshi ISHII
* Update japanese translation of newbs.md and related documents. * document link id change * add `ja/` in each link `[xxx](yyy.md)` --> `[xxx](ja/yyy.md)` * copy docs/ja/_summary.md from umi-umi's #7248 and fix it
2019-11-21[Docs] fix broken link in docs/newbs_best_practices.md (#7430)Takeshi ISHII
2019-11-20Add flake8 to our test suite and fix all errors (#7379)skullydazed
* Add flake8 to our test suite and fix all errors * Add some documentation
2019-11-20[Docs] Start of German translation of documentation (#6909)kuchosauronad0
* 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>
2019-11-20fix feature_advanced_keycodes.md's link (#7421)Takeshi ISHII
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) ```
2019-11-19Fix typo and code indentation (#7410)Mihai Olteanu
2019-11-19[Docs] Fix Japanese country flag (#7407)shela
2019-11-17[Docs] Modified the description about setting debug_enable in ↵Takeshi ISHII
`docs/faq_debug.md`. (#7394)
2019-11-17Doc fix to conform with #7221 (#7392)Erovia
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-26 21:12:35 +0000