summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-03-31Update newbs_getting_started.mdBram de Wilde
qmk is not available in the official Arch repositories. It is in the AUR, this install command will work if user has `yay` installed.
2020-03-31Rename UC_OSX (and related constants) to UC_MAC (#8589)Konstantin Đorđević
* 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
2020-03-31Add Japanese translation of cli_commands.md (#8513)shela
2020-03-31[Docs] Update Japanese translation of cli.md (#8510)shela
* 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>
2020-03-31[Docs] Update Japanese translation of faq related documents (#8521)shela
* 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>
2020-03-31Update Japanese translation of config_options.mdshela
2020-03-31Update Japanese translation with prefix 'getting'shela
2020-03-29[Docs] added the description of the reading order of the rules.mk files. (#8566)Takeshi ISHII
* 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>
2020-03-26Fix wrong python-pip package for MSYS setup instructionsfauxpark
2020-03-25[Docs] added the description of the reading order of the config.h files. (#8545)Takeshi ISHII
* 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
2020-03-24[Docs] Update RGB Matrix docs with function refs (#8367)Drashna Jaelre
* [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>
2020-03-24[Docs] Update Japanese translation of custom_quantum_functions.md (#8520)shela
2020-03-24[Docs] Update Japanese translation of _summary.md (#8508)shela
* Update Japanese translation of _summary.md * Update translation * Update translation
2020-03-24[Docs] Update Japanese translation of README.md (#8507)shela
* 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>
2020-03-24Update Japanese translation of flashing.mdshela
2020-03-24Update Japanese translation of keymap.mdshela
2020-03-24Update Japanese translation of contributing.mdshela
2020-03-23Add Post Processing to process_record (#4892)Drashna Jaelre
* 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
2020-03-23Add Word Per Minute calculation feature (#8054)brickbots
* 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>
2020-03-22[Docs] Trivial documentation fix (#8509)shela
* Trivial documentation fix * fix * fix * fix translation
2020-03-21Add support for Bootmagic lite when using SPLIT_HAND_PIN (#8347)Joel Challis
* 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
2020-03-21[Docs] Fixes for feature_rgblight.md (#8514)James Young
* remove extra comma that breaks the RGBLight Layers example * linting - use four spaces instead of tabs for indenting - remove trailing spaces
2020-03-21[Docs] Update layer documentation (#8371)Drashna Jaelre
* [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
2020-03-21Update newbs installation procedure for MSYS2 (#8423)Ryan
2020-03-18[Docs] Japanese translation of docs/custom_matrix.md (#8463)Takeshi ISHII
* 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
2020-03-17[docs] Note the need to flash both sides for rgb layers. (#8467)Frei
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
2020-03-17ARM - ADC cleanup (#8385)Joel Challis
* 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>
2020-03-16Document 'make all:<name>' (#8439)Joel Challis
* 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>
2020-03-15[Docs] Random Fixes (#8340)James Young
* 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
2020-03-15Fix some broken links in the docs (#8394)skullydazed
* 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>
2020-03-15[Docs] Update to I2C docs: Clarify address expectation and return values (#8413)brickbots
* Clarifying docs for i2c * Fix typo * Fix up punctuation * Implementing great suggestions * Update docs/i2c_driver.md * Update docs/i2c_driver.md
2020-03-14Adding OLED scroll setup functions (#8386)brickbots
* Adding scroll setup functions: * Clarifying values stored in oled_scroll_speed
2020-03-14fix two links on docs/other_eclipse.md (#8417)Takeshi ISHII
2020-03-14Update link for Learn Plover google site (#8410)Andy Jack
2020-03-13Decouple mouse cursor and mouse wheel in accelerated mode (#6685)francislan
* Decouples mouse cursor and mouse wheel movements in accelerated mode. * Fixed comment indentation. * Updated docs Co-authored-by: Francis LAN <francislan@google.com>
2020-03-12Restore getting_started_github.md docJames Young
2020-03-12Fix darkmode (#8393)Nick Brassel
* 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>
2020-03-12Add support for STM32L0/L1 onboard EEPROM. (#8002)Nick Brassel
* 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>
2020-03-11Add ADC support for STM32F3 and STM32F0 devices (#7681)Drew Mills
* Add ADC support for STM32F3 and STM32F0 devices * Add section about configration options available to the ARM ADC implementation * Fix STM32 typo
2020-03-10Rename qmk json-keymap to qmk json2c (#8372)skullydazed
2020-03-10Feature: RGBLight layers (#7768)Nathan Gray
* 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.
2020-03-06[Docs] i2c_driver translation to Japanese (#8274)kymok
* [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>
2020-03-07Buffer based OLED panning, write byte to buffer at arbitrary index (#8055)brickbots
* 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
2020-03-06[Docs] Fix links in Config Options docJames Young
2020-03-07Correct typo in tap_hold.md (#8326)Shaun
Correct typo: "reasonal" to "reasonable"
2020-03-05link the 2020 Feb 29 Breaking Changes changelog from the summaryJames Young
2020-03-05keycodes.md: hard-code section link id attributesJames Young
2020-03-05keycodes.md: don't use section headings as linksJames Young
It prevents the Table of Contents from parsing that heading.
2020-03-05make sure all our redirects are in orderskullY
2020-03-05Add more call to action itemsskullY
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-16 05:53:58 +0000