summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* add japanese translation (feature part 01) (#8196)umi2020-04-026-0/+1024
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add feature part 01 * update sentences * update sentences * update sentences * update file based on comment * leave ctrl, shift, alt key name as alphabet * update file based on comment * update file based on comment * update file based on comment * update file based on comment * remove unnecessary space on define line * update sentence based on pull request's comment * translate 'breathing' in document * change expression in table * update file based on comment * change the word 'brightness', and update based on comment * update based on comment * update based on comment * add language directory name to each internal link * update based on comment * update based on comment
* [Docs] Update Japanese translation of i2c_driver.md (#8523)shela2020-04-011-24/+34
| | | | | * Update Japanese translation of i2c_driver.md * Apply a part of suggestions from code review
* [Docs] Japanese translation of hardware_*.md (#8278)Takuya Urakawa2020-04-013-0/+389
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add docs/ja/hardware.md * add docs/ja/hardware_avr.md * add docs/ja/hardware_drivers.md * add docs/ja/hardware_keyboard_guidelines.md * update hardware.md * add space around alphabet word * fix link tag * Apply suggestions from code review Co-Authored-By: shela <shelaf@users.noreply.github.com> * remove ja/hardware.md * Apply suggestions from code review Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * match word matrix with other translations * Apply suggestions from code review Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: shela <shelaf@users.noreply.github.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Update newbs_getting_started.mdBram de Wilde2020-03-311-1/+1
| | | qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
* Rename UC_OSX (and related constants) to UC_MAC (#8589)Konstantin Đorđević2020-03-312-8/+10
| | | | | | | | | | | | | | | | | | | | | * Rename UC_OSX (and related constants) to UC_MAC * Update UNICODE_SONG_OSX references to UNICODE_SONG_MAC * Update UC_M_OS references to UC_M_MA * Add UC_OSX alias for backwards compatibility * Add deprecation warning for UC_OSX to Unicode docs * Add UC_M_OS alias for backwards compatibility * Update newly found UC_M_OS and UNICODE_SONG_OSX references * Add legacy UNICODE_MODE_OSX alias, revert changes to user keymaps * Add legacy UNICODE_SONG_OSX alias, revert changes to user keymaps * Replace removed sounds in Unicode song doc examples
* Add Japanese translation of cli_commands.md (#8513)shela2020-03-311-0/+258
|
* [Docs] Update Japanese translation of cli.md (#8510)shela2020-03-311-263/+9
| | | | | | | | | * Update Japanese translation of cli.md * Update docs/ja/cli.md Co-Authored-By: s-show <s1shimz@gmail.com> Co-authored-by: s-show <s1shimz@gmail.com>
* [Docs] Update Japanese translation of faq related documents (#8521)shela2020-03-313-16/+54
| | | | | | | | | * Update Japanese translation of faq related documents * Update docs/ja/faq_general.md Co-Authored-By: s-show <s1shimz@gmail.com> Co-authored-by: s-show <s1shimz@gmail.com>
* Update Japanese translation of config_options.mdshela2020-03-311-134/+140
|
* Update Japanese translation with prefix 'getting'shela2020-03-314-170/+4
|
* [Docs] added the description of the reading order of the rules.mk files. (#8566)Takeshi ISHII2020-03-291-0/+15
| | | | | | | | | | | | | * added the description of the reading order of the rules.mk files. * Update docs/hardware_keyboard_guidelines.md Co-Authored-By: Ryan <fauxpark@gmail.com> * Update docs/hardware_keyboard_guidelines.md Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Fix wrong python-pip package for MSYS setup instructionsfauxpark2020-03-261-1/+1
|
* [Docs] added the description of the reading order of the config.h files. (#8545)Takeshi ISHII2020-03-251-0/+51
| | | | | | | | | | | | | | | | | | | | | | * added the description of the reading order of the config.h files. * Update docs/hardware_keyboard_guidelines.md * Update docs/hardware_keyboard_guidelines.md * Added a description of post_config.h. * sample bug fix * sample update * Update docs/hardware_keyboard_guidelines.md * Update docs/hardware_keyboard_guidelines.md * update docs/hardware_keyboard_guidelines.md * Update docs/hardware_keyboard_guidelines.md
* [Docs] Update RGB Matrix docs with function refs (#8367)Drashna Jaelre2020-03-241-6/+76
| | | | | | | | | | | * [Docs] Update RGB Matrix docs with function refs * Fix up code samples * suggestions by noroadsleft * Fix small typo Co-authored-by: James Young <xxiinophobia@yahoo.com>
* [Docs] Update Japanese translation of custom_quantum_functions.md (#8520)shela2020-03-241-8/+33
|
* [Docs] Update Japanese translation of _summary.md (#8508)shela2020-03-241-119/+151
| | | | | | | * Update Japanese translation of _summary.md * Update translation * Update translation
* [Docs] Update Japanese translation of README.md (#8507)shela2020-03-241-14/+25
| | | | | | | | | | | * Update Japanese translation of README.md * Apply suggestions from code review * Apply suggestions from code review * Update translation Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Update Japanese translation of flashing.mdshela2020-03-241-4/+4
|
* Update Japanese translation of keymap.mdshela2020-03-241-4/+5
|
* Update Japanese translation of contributing.mdshela2020-03-241-5/+5
|
* Add Post Processing to process_record (#4892)Drashna Jaelre2020-03-232-0/+49
| | | | | | | | | | | | | | | | | | | * Improve process_record system Code based on @colinta's * Rename and better handle functions * Fix incorrect function call to process_record_user * Add documentation for post_process_record * Add both get_event_keycode and get_record_keycode functions And add some comments about these functions * Update code format * Cleanup merge artifacts
* Add Word Per Minute calculation feature (#8054)brickbots2020-03-232-0/+26
| | | | | | | | | | | | | | | | | | | | | * Add Word Per Minute calculation feature * Fix copyright info * Remove header from quantum.c, setup overloadable keycode inclusion for WPM, update docs * Simplify logic for keycode filtering * Adding link from summary to wpm_feature info * Update docs/feature_wpm.md Typo in function prototype example in docs Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Add WPM transport via i2c Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* [Docs] Trivial documentation fix (#8509)shela2020-03-221-6/+6
| | | | | | | | | * Trivial documentation fix * fix * fix * fix translation
* Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347)Joel Challis2020-03-211-4/+15
| | | | | | | | | * Add support for Bootmagic lite when using SPLIT_HAND_PIN * Deduplicate bootmagic_lite logic from within via * Revert location of defaults so that user overrides still work for now * Tidy up code slightly
* [Docs] Fixes for feature_rgblight.md (#8514)James Young2020-03-211-16/+16
| | | | | | | | * remove extra comma that breaks the RGBLight Layers example * linting - use four spaces instead of tabs for indenting - remove trailing spaces
* [Docs] Update layer documentation (#8371)Drashna Jaelre2020-03-215-48/+104
| | | | | | | | | | | | | | | | | | | | | | | | * [Docs] Update layer documentation * Add layer_state_cmp functions * Fix cut/copy/paste issue * Add id tags * Apply noroads corrections * Move Layers section to separate document * Fix ID tag for layers * Use better name for summary/side bar * Fix feature page linkage As well as a small spell error close by * Remove paper analogy for now
* Update newbs installation procedure for MSYS2 (#8423)Ryan2020-03-211-2/+6
|
* [Docs] Japanese translation of docs/custom_matrix.md (#8463)Takeshi ISHII2020-03-182-2/+116
| | | | | | | | | | | | | | | * add docs/ja/custom_matrix.md * add original document TAG * update ja/custom_matrix.md * 「マトリクス」to 「マトリックス」 * docs/ja/custom_matrix.md:update section title * update docs/ja/custom_matrix.md * update docs/ja/custom_matrix.md
* [docs] Note the need to flash both sides for rgb layers. (#8467)Frei2020-03-171-0/+2
| | | | | | Update feature_rgblight.md to note that for split dual-mcu boards, both sides must be flash to get the new value of the rgblight_layers. https://github.com/qmk/qmk_firmware/pull/7768#issuecomment-600237611
* ARM - ADC cleanup (#8385)Joel Challis2020-03-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update switch to array to allow custom values * Add adc keymap * update docs to reflect alignment of default 10 bit * start conversion to USE_ADCVn * samplerate is hella wrong...stub out for now * basic f1 and f4 functionality * Tidy up current changes * Restore old pinToMux function * Add back sample rate for supported platforms * F0 compile fixes * wordsmithery Co-Authored-By: Ryan <fauxpark@gmail.com> * Remove reference to avr only function Co-authored-by: Ryan <fauxpark@gmail.com>
* Document 'make all:<name>' (#8439)Joel Challis2020-03-162-4/+22
| | | | | | | | | | | * Document 'make all:<name>' * add cli docs * Apply suggestions from code review Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
* [Docs] Random Fixes (#8340)James Young2020-03-157-105/+106
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * fix CLI section links in the Summary * fix heading in Pointing Device doc * fix headings in PS/2 Mouse Support doc * add explicit section ids to I2C Master Driver doc * reformat GPIO Controls table Much like the I2C Master Driver doc, I found this a bit less than ideal to read. (The table was actually wider than the space available for it.) Reformatted so each GPIO function is an H3 heading, followed by a paragraph and a table of each architecture's old-style function. * migrate changes from I2C Master Driver doc to Japanese translation * add explicit anchors to I2C Master Driver docs * fix code block language markers The language markers are case-sensitive; using the wrong case means the syntax highlighting doesn't work. Good: ```c Bad: ```C * restore Japanese I2C Master Driver doc to current master Can't update the internal tracking references accurately until the changes to the English doc are committed to master. * add explicit anchors to edited files * change ChibiOS/ARM to ARM/ChibiOS Because ARM/ATSAM is also a thing that exists. * fix code block language markers again Used the wrong markers in a few spots. Also these are apparently always supposed to be lowercase. * add section anchors to cli.md * restore table formatting on GPIO Control doc * remove changes to _summary.md
* Fix some broken links in the docs (#8394)skullydazed2020-03-155-283/+254
| | | | | | | | | | | | | * fix some broken links * remove duplicate and confusing material from cli.md * Switch brazil to the 2 letter country code * Update docs/_langs.md Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* [Docs] Update to I2C docs: Clarify address expectation and return values (#8413)brickbots2020-03-151-11/+24
| | | | | | | | | | | | | | * Clarifying docs for i2c * Fix typo * Fix up punctuation * Implementing great suggestions * Update docs/i2c_driver.md * Update docs/i2c_driver.md
* Adding OLED scroll setup functions (#8386)brickbots2020-03-141-2/+14
| | | | | * Adding scroll setup functions: * Clarifying values stored in oled_scroll_speed
* fix two links on docs/other_eclipse.md (#8417)Takeshi ISHII2020-03-141-1/+1
|
* Update link for Learn Plover google site (#8410)Andy Jack2020-03-141-1/+1
|
* Decouple mouse cursor and mouse wheel in accelerated mode (#6685)francislan2020-03-131-0/+3
| | | | | | | | | * Decouples mouse cursor and mouse wheel movements in accelerated mode. * Fixed comment indentation. * Updated docs Co-authored-by: Francis LAN <francislan@google.com>
* Restore getting_started_github.md docJames Young2020-03-121-0/+65
|
* Fix darkmode (#8393)Nick Brassel2020-03-123-1/+31
| | | | | | | | | | | | | | | | | | | | | | | | * Rearrange the custom CSS a bit. * fix css name * add missing quote * Fix up dark mode rendering. (#8392) * Fix up dark mode rendering. * Update index.html * Fix up code blocks * Fix code in page toc * Update docs/qmk_custom_dark.css Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: skullY <skullydazed@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Add support for STM32L0/L1 onboard EEPROM. (#8002)Nick Brassel2020-03-121-5/+7
| | | | | | | | | * Add support for STM32L0/L1 onboard EEPROM. * Update docs/eeprom_driver.md Co-Authored-By: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
* Add ADC support for STM32F3 and STM32F0 devices (#7681)Drew Mills2020-03-111-1/+104
| | | | | | | * Add ADC support for STM32F3 and STM32F0 devices * Add section about configration options available to the ARM ADC implementation * Fix STM32 typo
* Rename qmk json-keymap to qmk json2c (#8372)skullydazed2020-03-102-4/+4
|
* Feature: RGBLight layers (#7768)Nathan Gray2020-03-102-0/+64
| | | | | | | | | | | | | | | | | * New feature: RGBLIGHT_LAYERS This feature allows users to define multiple independent layers of lighting that can be toggled on and off individually, making it easy to use your RGB lighting to indicate things like active keyboard layer & modifier state. * Demonstrate built in functions for layer state checking Also link the video in the docs. * Follow existing pattern for setting rgblight_status flags * Eliminate rgblight_is_static_mode since it's not needed Just check to see if the timer is enabled directly.
* [Docs] i2c_driver translation to Japanese (#8274)kymok2020-03-061-0/+128
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * [WIP] i2c_driver translation to ja * update docs/ja/i2c_driver.md * update docs/ja/i2c_driver.md * align table + remove comment * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * Update docs/ja/i2c_driver.md * add original document commit hash Co-Authored-By: shela <shelaf@users.noreply.github.com>
* Buffer based OLED panning, write byte to buffer at arbitrary index (#8055)brickbots2020-03-071-0/+9
| | | | | | | | | * Add buffer based single line pan, arbitrary byte write to buffer * Change dirty mask to inverse of OLED_BLOCK_TYPE for future proofing larger buffer sizes * Updating docs to include new functions * Updating to clarify scroll vs pan
* [Docs] Fix links in Config Options docJames Young2020-03-061-4/+4
|
* Correct typo in tap_hold.md (#8326)Shaun2020-03-071-1/+1
| | | Correct typo: "reasonal" to "reasonable"
* link the 2020 Feb 29 Breaking Changes changelog from the summaryJames Young2020-03-051-0/+1
|
* keycodes.md: hard-code section link id attributesJames Young2020-03-051-22/+22
|