summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* [CLI] Add a subcommand for getting information about a keyboard (#8666)Zach White2020-05-261-2/+35
| | | | | You can now use `qmk info` to get information about keyboards and keymaps. Co-authored-by: Erovia <Erovia@users.noreply.github.com>
* [Docs] Japanese translation of docs/feature_pointing_device.md (#8993)umi2020-05-261-0/+49
| | | | | | | | | | | * add feature_pointing_device.md translation * update based on comment * update based on comment * update based on comment * update based on comment
* Fix capitalisation of "GitHub" (#9184)Ryan2020-05-2538-63/+63
|
* Fixed the indentation of the sample code in feature_pointing_device docs (#9177)Takeshi ISHII2020-05-231-9/+6
| | | | | | | | | * Fixed the indentation of the sample code in docs/feature_pointing_device.md sample. * Update docs/feature_pointing_device.md Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
* Update ARM split keyboard docs (#9160)Joel Challis2020-05-223-5/+26
| | | | | | | | | * Update ARM split keyboard docs * Update docs/serial_driver.md Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
* ARM split - Add uart half duplex transport support (#7987)Joel Challis2020-05-212-0/+60
| | | | | | | | | | | | | | | * ARM split - Add uart half duplex transport support * Fix for f103 * initial full duplex pass * partially remove full duplex * Correct speeds within driver docs Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
* [Docs] newbs_flashing.md: place bootloader instructions before Toolbox intro ↵Ryan2020-05-211-40/+42
| | | | | | | | | | | | (#9077) * newbs_flashing.md: place bootloader instructions before Toolbox intro * Update docs/newbs_flashing.md * More wordsmithing, point ARM users at Discord if all else fails * Link Discord
* Allow for overriding RAW endpoint usage page and ID. (#8834)Nick Brassel2020-05-211-1/+5
| | | | | | | * Allow for overriding RAW endpoint usage page and ID. * Move usb_descriptor_common.h. * Docs update.
* CLI: Improve experience when running `qmk setup` on FreeBSD. (#8798)Pete Johanson2020-05-201-2/+19
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * CLI: Improve experience when running `qmk setup` on FreeBSD. * Install the `avrdude` package as well. * Switch to installing python packages w/ `--user` flag. * Basic getting started sections for FreeBSD. * Update `util/freebsd_install.sh` for root/non-root branches. * Add ID to doc section. Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Add ID to another docs section. Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Use `; then` in script for consistency. Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Updated to use sudo in one shot if available. * Apply suggestions from code review Co-authored-by: Erovia <Erovia@users.noreply.github.com> * Style fixes for latest version in master. * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: skullydazed <skullydazed@users.noreply.github.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Reintegrate previous docker docs (#9084)Joel Challis2020-05-192-1/+50
|
* Streamline the macos install processskullY2020-05-183-21/+9
|
* [Docs] Japanese translation of docs/feature_led_matrix.md (#8991)umi2020-05-181-0/+95
| | | | | | | * add feature_led_matrix.md translation * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_layouts.md (#8949)umi2020-05-181-0/+114
| | | | | | | * add feature_layouts.md translation * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_thermal_printer.md (#9034)umi2020-05-181-0/+15
| | | * add feature_thermal_printer.md translation
* [Docs] Japanese translation of docs/feature_velocikey.md (#9035)umi2020-05-181-0/+35
| | | | | | | * add feature_velocikey.md translation * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_leader_key.md (#8950)umi2020-05-181-0/+151
| | | | | | | | | | | | | * add feature_leader_key.md translation * update based on comment * set link as lang dir * update based on comment * update based on comment * update based on comment
* Add SPI 25xx EEPROM support. (#8780)Nick Brassel2020-05-191-5/+24
|
* Add query functions for RGB Light and RGB Matrix (#8960)Drashna Jaelre2020-05-182-12/+18
| | | | | | | | | | | | | * Add additional query functions for RGBLIGHT * Add additional query functions for RGB Matrix * Change names of enable check functions * Fix macro for rgb matrix takeover of rgblight functions * Add documentation for rgb_matrix_get_hsv() * Add *_get_hsv function to rgblight
* [Docs] Clarify layer transparency keymap.md (#9081)Nick Blyumberg2020-05-161-4/+16
| | | | | | | | | | | | | | | | | | * Revised the grammar and clarity of the Layer Precedence and Transparency * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md * Update docs/keymap.md
* Improve stock bootloader list (#9067)Ryan2020-05-131-6/+12
| | | | | | | | | | | | | * Improve stock bootloader list * Switch version numbers on USB64/128 bootloaders * Unix line endings for PS2AVRGB bootloader * Update PS2AVRGB bootloader to 1.0.1 * Also mention bootloader rule * Didn't need to change the links
* One shot support for swap hands (#8590)Zsolt Parragi2020-05-142-0/+2
| | | | | | | | | | | | | | | | This commits add the SH_OS keycode, which works similarly to one shot layers: * while pressed, the keyboard is swapped * if no keys were pressed while it was pressed, the next key press is swapped SH_OS also supports chaining with one shot layers: OSL(x) + SH_OS + key interprets the key press on the oneshot layer. The ONESHOT_TIMEOUT setting used by one shot keys and layers is also used by oneshot swap hands. In the above chaining scenario the timeout of the oneshot layer is reset when swap hands is activated. Resolves #2682
* Allow expanding from 8 to 32 RGB Lighting Layers (#8941)Joshua Diamond2020-05-132-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Allow 16 lighting layers * Require #define RGBLIGHT_LAYERS_16 to enable 16 layers * Override RGBLIGHT_MAX_LAYERS to set maximum number of lighting layers * Enforce lower bound on RGBLIGHT_MAX_LAYERS Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Fix an error in the check for valid RGBLIGHT_MAX_LAYERS * Don't use bitfield / PACKED, as it causes bloat * Update documentation re: up to 32 lighting layers * Run cformat * Add note about increasing FW size in docs/config_options.md Co-authored-by: Drashna Jaelre <drashna@live.com> * Remove no-longer-valid comment * Add doc note that split sync will be slower Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
* fixed typo for clear lcd screen function in hd44780 docs (#9086)floookay2020-05-132-2/+2
| | | | | | | * fixed typo for clear lcd screen function brought to attention by #9085 * fixed typo for clear lcd screen function (ja docs)
* Docs: fix links in feature_hd44780.md (#9053)James Young2020-05-091-2/+2
| | | The referenced site was moved.
* New RGB Lighting effect: Twinkle (#8887)Joshua Diamond2020-05-091-2/+9
| | | | | | | | | | | | | * Add twinkle RGB Lighting effect * 2nd twinkle algo - double-buffering * Further refinement: Per-LED twinkle * Add documentation for Twinkle RBG Lighting mode * Bias twinkle saturation closer to the set value * Fix whitespace
* Add ability to blink lighting layer for a specified duration (#8760)Joshua Diamond2020-05-092-3/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Implement momentarily blink of lighting layers * Refactor spidey3 userspace to use rgb layer blink * Remove un-necessary line from example in documentation * Revert "Refactor spidey3 userspace to use rgb layer blink" This reverts commit 831649bb680c41c6d663ae6fa86d13f4f8bebdd8. * Adds a missing bit of documentation about lighting layer blink * Update docs/feature_rgblight.md per suggestions Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_rgblight.md per suggestions Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Update docs/feature_rgblight.md per suggestions Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * cformat, as suggested Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* Add redirect for old getting started links (#8987)Joel Challis2020-05-021-1/+2
|
* [Documentation] Added raw hid documentation page (#7640)Ahmed Elshafey2020-05-012-0/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added raw hid feature documentation page * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/features.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * added feature_rawhid.md to _summary.md in docs * fixed _summary.md order * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update feature_rawhid.md Removed the useless bit about finding usage page and usage. * Update feature_rawhid.md * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Remove teensy client, small origanization fixes * Fixed merge conflicts Removed features.md Updated _summary.md with new format and added RAW HID entry under Software Features * Added rawhid feature page Messy is what you get when you don't do things right the first time Co-authored-by: fauxpark <fauxpark@gmail.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
* [Docs] Japanese translation of docs/feature_key_lock.md (#8948)umi2020-05-011-0/+27
| | | | | | | * add feature_key_lock.md translation * update based on comment * set link as lang dir
* [Docs] Japanese translation of docs/feature_haptic_feedback.md (#8874)umi2020-05-011-0/+163
| | | | | | | * add feature_haptic_feedback.md translation * update based on comment * update based on comment
* add 'togglePin' convenience function (#8734)JohSchneider2020-04-291-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add 'togglePin' conveniance function for AVR and chibios * drop outmost parantheses Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * toggle pin on avrs toggle a pin configured as output by writing the corresponding bit to the PIN register Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * togglepin: add documentation for newly added function * Update docs/internals_gpio_control.md Co-Authored-By: Konstantin Đorđević <vomindoraan@gmail.com> * on AVR: use PORTD to toggle the output ... since not all MCUs support toggling through writing to PIN Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: Johannes <you@example.com> Co-authored-by: Konstantin Đorđević <vomindoraan@gmail.com> Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Add SPI master for ChibiOS/ARM. (#8779)Nick Brassel2020-04-291-1/+18
|
* Edit Unit Testing Documentation (#8961)Alexander Hart2020-04-291-1/+1
|
* Update and try to clarify the CLI installation on Linux (#8783)Erovia2020-04-271-3/+14
| | | | | | | | | | | * Update and try to clarify the CLI installation on Linux * Update commands, add note for Debian/Ubuntu * Update docs/newbs_getting_started.md Co-Authored-By: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
* [Docs] Japanese translation of docs/feature_grave_esc.md (#8873)umi2020-04-271-0/+37
| | | | | | | | | | | | | * add feature_grave_esc.md translation * update based on comment * update based on comment * update based on comment * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_hd44780.md (#8875)umi2020-04-271-0/+62
| | | | | | | | | * add feature_hd44780.md translation * update based on comment * update based on comment * update based on comment
* [Docs] Japanese translation of docs/feature_dynamic_macros.md (#8842)umi2020-04-261-0/+71
| | | | | | | | | | | * add feature_dynamic_macros.md translation * add header * add header * update based on comment * update based on comment
* fix sample code indent in feature_encoders.md (#8883)Takeshi ISHII2020-04-232-2/+2
|
* [Docs] Japanese translation of docs/feature_encoders.md (#8843)umi2020-04-201-0/+81
| | | | | * add feature_encoders.md translation * update based on comment
* [Docs] Japanese translation of docs/feature_command.md (#8672)umi2020-04-201-0/+56
| | | | | * add feature_command.md translation * update based on comment
* [Docs] Fixed minor typos (#8860)Chris Ko2020-04-192-7/+7
|
* Add a syllabus to guide people who are learning QMK (#8816)skullydazed2020-04-192-0/+71
|
* Move everything to Python 3.6 (#8835)skullydazed2020-04-183-7/+7
|
* Document the Proton C pins for manual Pro Micro conversion (#7043)skullydazed2020-04-181-6/+63
|
* Remove Atmel FLIP from install scripts and documentation (#8822)Ryan2020-04-1711-40/+0
|
* [Docs] Japanese translation of docs/feature_combo.md (#8671)umi2020-04-151-0/+108
| | | | | | | | | * add feature_combo.md translation * change tiny word * update based on comment * update based on comment
* Add missing repository name to qmk setup w/ github (#8792)mimkorn2020-04-141-1/+1
| | | Using just qmk setup <github_username> would fail w/ "Could not find repo github.com/<username>, whereas the repo is actually after another slash after the user name. Can consider changing code to add the default forked repo name if slash is not detected in the arg.
* [Docs] Japanese translation of docs/feature_dip_switch.md (#8673)umi2020-04-131-0/+95
| | | | | | | * add git_dip_switch.md translation * update based on comment * update based on comment
* Fix AVR SPI parameter configuration, remove timeouts due to sync protocol. ↵Nick Brassel2020-04-131-19/+12
| | | | (#8775)
* Add support for hardware and board initialisation overrides. (#8330)Nick Brassel2020-04-132-0/+57
| | | | | | | | | | | | | | | | | | | | | | | | | * Add support for hardware and board initialisation overrides. * qmk cformat. * Add some documentation. * Docs clarity. * Make early_hardware_init_pre a no-op for now, until migrations occur. * Doco update * Make distinction between keyboard and ChibiOS board in docs * Doc anchors. * Update tmk_core/protocol/chibios/main.c Co-Authored-By: Joel Challis <git@zvecr.com> * Rework bootloader entry to be off by default, allow opting-in. Co-authored-by: Joel Challis <git@zvecr.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-15 10:59:28 +0000