summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-12-01Add tap_random_base64 and software timer info to Useful Functions doc (#4360)Drashna Jaelre2-17/+21
* Update docs * Add security caveat Co-Authored-By: drashna <drashna@live.com> * Wordsmithing Co-Authored-By: drashna <drashna@live.com> * Update docs/ref_functions.md Co-Authored-By: drashna <drashna@live.com>
2018-11-30Test out i18n of the docs (#4519)Jack Humbert1-0/+32
* add zh-cn readme * edit readme * Round 1 of edits - Mandarin translation of QMK products is off, best to use the English name. - Fix some terminology and grammar. * trying re-translating the first paragraph
2018-11-29Typo fix (#4515)Paul Massendari1-1/+1
2018-11-28Add Extrakey support for Brightness up/down (#4477)Giuseppe Rota3-0/+6
2018-11-28Remove RGB_SMOD alias and replace uses with RGB_MOD (#4319)Konstantin Đorđević1-2/+0
2018-11-27Fixed docs/newbs_testing_debugging.md and tmk_core/common/print.hmtei1-1/+1
2018-11-26Revert "Add support for PR and Issue templates to QMK_firmware GitHub ↵Drashna Jaelre1-43/+0
(#4491)" (#4492) This reverts commit b91dfa04e3bad560fb6fe2360dd51fb95d95fcbf.
2018-11-26Add support for PR and Issue templates to QMK_firmware GitHub (#4491)Drashna Jaelre1-0/+43
* Add support document * Add Bug Report * Add GitHub Pull Request Template * Feature request issue template * Touch up feature request template * Add 'other issues' template * move support doc
2018-11-26Keymap FAQ: fix positions of KC_HENK and KC_MHEN for JIS layout (#4482)noroadsleft1-2/+2
These keys were previously in each other's positions.
2018-11-24Add EEPROM_RESET keycode to keycodes.md doc (#4473)noroadsleft1-12/+13
2018-11-18Allows disabling rgb effects in userspace (#4422)Florian Didron1-0/+24
* Allows disabling animations in user space * Describe disabling effects in the docs * Allows disabling individual reactive modes * Adds the list ode defines
2018-11-16Use a single endpoint for HID reports (#3951)James Laird-Wah1-0/+29
* Unify multiple HID interfaces into one This reduces the number of USB endpoints required, which frees them up for other things. NKRO and EXTRAKEY always use the shared endpoint. By default, MOUSEKEY also uses it. This means it won't work as a Boot Procotol mouse in some BIOSes, etc. If you really think your keyboard needs to work as a mouse in your BIOS, set MOUSE_SHARED_EP = no in your rules.mk. By default, the core keyboard does not use the shared endpoint, as not all BIOSes are standards compliant and that's one place you don't want to find out your keyboard doesn't work.. If you are really confident, you can set KEYBOARD_SHARED_EP = yes to use the shared endpoint here too. * unify endpoints: ChibiOS protocol implementation * fixup: missing #ifdef EXTRAKEY_ENABLEs broke build on AVR with EXTRAKEY disabled * endpoints: restore error when too many endpoints required * lufa: wait up to 10ms to send keyboard input This avoids packets being dropped when two reports are sent in quick succession (eg. releasing a dual role key). * endpoints: fix compile on ARM_ATSAM * endpoint: ARM_ATSAM fixes No longer use wrong or unexpected endpoint IDs * endpoints: accommodate VUSB protocol V-USB has its own, understandably simple ideas about the report formats. It already blasts the mouse and extrakeys through one endpoint with report IDs. We just stay out of its way. * endpoints: document new endpoint configuration options * endpoints: respect keyboard_report->mods in NKRO The caller(s) of host_keyboard_send expect to be able to just drop modifiers in the mods field and not worry about whether NKRO is in use. This is a good thing. So we just shift it over if needs be. * endpoints: report.c: update for new keyboard_report format
2018-11-15Docs: Supporting a keyboard in the QMK Configurator (#4396)noroadsleft3-0/+197
* Docs: Configurator Support * Minor updates * Updated keyboard.h example to use #pragma once per @drashna https://github.com/qmk/qmk_firmware/pull/4396#discussion_r232140934 * Add link to doc under Reference section Added to _sidebar.md and _summary.md * Changed doc title; minor tweaks Re-titled the doc as "Supporting Your Keyboard in QMK Configurator". Made some minor changes to the keyboard.h examples. * Added tags object to JSON example
2018-11-14Backlight status functions (#4259)Phillip Tennen1-8/+11
* add functions to set specific backlight state * add function to query backlight state * update documentation with new backlight functions * Update tmk_core/common/backlight.c Co-Authored-By: codyd51 <phillip.ennen@gmail.com> * Update tmk_core/common/backlight.h Co-Authored-By: codyd51 <phillip.ennen@gmail.com> * update docs for is_backlight_enabled() name change
2018-11-14Fixed Unicode Support heading (#4425)James Osborn1-0/+1
Previously, Unicode Support heading appeared as the last row in the Swap Hands table.
2018-11-13Docs: Fix descriptions of KC_INT1 and KC_INT3KOBAYASHI Daisuke2-4/+4
2018-11-13Remove duplicate row from Available functions table in i2c_driver doc (#4416)Junya Ogura1-1/+0
2018-11-13Fixed incorrect link to feature_combo.md in features.md docs file. Was ↵TheOneTrueTrench1-1/+1
linked to feature_combos.md, but _sidebar.md, _summary.md, and config_options.md all link to feature_combo.md. Assuming that it should not be pluralized. (#4411)
2018-11-12Make sure that avr-gcc@7 gets linked into the path on MacOS.Michael Kaylan2-1/+2
2018-11-10I2C driver docs (#4298)yiancar3-0/+85
* I2C driver docs - Added I2C driver docs. - Changed arm master i2c driver to have a weak i2c_init as it is impossible to account for all possible port configuration in the STM32 world. * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * Update docs/i2c_driver.md Co-Authored-By: yiancar <yiangosyiangou@cytanet.com.cy> * GPIO release fix
2018-11-07Configurable Rainbow Swirl range (#4376)Frank Tackitt1-0/+1
* Configurable Rainbow Swirl range This allows tweaking of the rainbow effect to get different effects on keyboards with varied LED layouts. We found the value 1950 works on the RGBKB.net Sol to get a cool striped effect across the keyboard. * Document RGBLIGHT_RAINBOW_SWIRL_RANGE * Better wording for the documentation
2018-11-06Improve wording, punctuation and capitalization in newbs_getting_started ↵Konstantin Đorđević1-40/+38
guide (#4342) * Improve wording, punctuation and capitalization in newbs_getting_started guide Also add some links * Update example build command output Co-Authored-By: vomindoraan <vomindoraan@gmail.com> * Replace occurrences of "layout" with "keymap" Co-Authored-By: MechMerlin <30334081+mechmerlin@users.noreply.github.com> * Explicitly instruct users to open an MSYS2 MinGW 64-bit terminal * MSYS2 Console → MSYS2 MinGW * Replace thin spaces with regular spaces
2018-11-06Update Features page to reflect all of the features linked in the ↵Drashna Jaelre1-0/+4
sidebar/summary
2018-11-06fix example to reflect caveatDrashna Jaelre1-5/+5
2018-11-06Add EEPROM_RESET keycode to core code (#4234)Drashna Jaelre1-12/+13
* Add EEPROM Reset keycode * Add keycode to docs * Move EEPROM Reset code to the end of the enum * Cleanup and naming change
2018-11-06Clarify the Mod Tap defines in documentation (#4352)Drashna Jaelre2-19/+52
* Fix up Mod Tap settings keys * Change link names * permissive hold wordsmith Co-Authored-By: drashna <drashna@live.com> * ignore mod tap wordsmithing Co-Authored-By: drashna <drashna@live.com> * grammar fix Co-Authored-By: drashna <drashna@live.com> * wordsmithing Co-Authored-By: drashna <drashna@live.com> * word smithing Co-Authored-By: drashna <drashna@live.com>
2018-11-06Remove ALTG(kc) as it's misleading and is not actually AltGr (#4338)Konstantin Đorđević2-2/+0
* Remove ALTG(kc) as it's misleading and is not actually AltGr * Add temporary alias for ALGR in keyboards/planck/keymaps/pevecyan/keymap.c
2018-11-03Instructions on how to flash via STM32 bootloader (#4316)Michael Pio1-4/+27
* Add instructions on flashing ARM keyboards with default STM32 bootloader * fixed typo; added note suggestion to step 4
2018-11-02Add support for Atmega32A to pin declarations and universal matrix (#4015)Jack Humbert1-1/+1
* add computed pins from mcu type * update for atmega32a * doc typo * add atmega16 chips, link to references * remove avr include from config * exclude assembler in config.h includes * consolodate options, add 646 * fix typo in pindef
2018-10-30Update feature_bootmagic.md (#4290)Leah1-1/+1
Fix typo
2018-10-27Add Bootmagic Lite to QMK (#4215)Drashna Jaelre1-1/+51
* Preliminary additon of bootmagic lite functionality * Cleanup code * Clean up bootmagic code * Add documentation and clean up code * Make 'lite' an option for BOOTMAGIC_ENABLE * Update Templates with note about Bootmagic Lite option * Detect Debounce variable * Make sure debounce is a non-zero number * Capitalize Bootmagic * Capitalize bootmagic * Update wording * Re-add EEPROM reset, by popular demand And add eeprom-less version to drashna userspace for his sanity * Fix spacing * Set BOOTMAGIC_ENABLE to use full/lite/off And default yes to "full" for compatibility * Add Bootmagic lite info to templates * Remove text from makefiles * Cleanup of makefile * mention yes in bootmagic docs * Wordsmitthing the docs * Fix white spaces * Readd default bootmagic setting, because it's necessary
2018-10-27Docs: Add references to One Shot functions, and clean up formatting (#4189)Drashna Jaelre1-5/+12
* Docs: Add references to One Shot functions, and clean up formatting * Update PR based on @mechmerlin's recommendations
2018-10-27Add caveat for basic keycodes in Tap Dance docsDrashna Jaelre1-0/+2
2018-10-27Add key caveat to combos docDrashna Jaelre1-0/+1
2018-10-26add better exampleJack Humbert1-2/+9
2018-10-26add support for encoders to coreJack Humbert3-0/+43
2018-10-26Fix incorrect doctoring in feature.backlight.md (#4244)Phillip Tennen1-1/+1
I'm guessing someone deleted a row at some point in the past, but I didn't blame it.
2018-10-25Fix syntax for windowsDrashna Jaelre1-1/+1
2018-10-22Update the installation script PR (#4167)Drashna Jaelre1-1/+1
* Update docs to use qmk_install * Update Vagrantfile to use qmk_install
2018-10-22Add caveats for shifted characters (#4192)Drashna Jaelre2-6/+18
* Add caveats for shifted characters And some formatting and grammar corrections. Closes #1037 * Fix spelling of remote * Fix spelling error * Remote not Remove * Remote not Remove
2018-10-22Update hardware config warnings to be more accurateDrashna Jaelre1-1/+1
Closes #3565
2018-10-22Minor updates to build tools docs revised (#4195)Dylan Khor1-3/+3
* add initial khord iris keymap * correct path of windows qmk install script
2018-10-22Updates docs - planck 6 and macos instructions (#4201)Colin T.A. Gray2-0/+3
* add note about how to install rev6 (dfu-util) * include instructions on installing dfu-util on macOS
2018-10-20Add instructions for zadig when bootloader device is unknownDrashna Jaelre1-1/+9
2018-10-19Some cleanup of the Useful Functions docs (#4064)Drashna Jaelre1-14/+64
* Add examples for tri layers * Clean up and spelling fixes
2018-10-19Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning ↵noroadsleft5-2/+171
Resources doc (#3902) * Docs: newbs_learn_more_resources.md: formatting * Added QMK Git Conventions doc, initial version * Renamed contributing_qmk.md to newbs_best_practices.md * Updated per review by @drashna * Added navigation links * Updated to Best Practices doc * Minor updates to Learn More Resources doc Markdown formatting consistency because I'm particular about it. * Added Merge Conflict section to Best Practices doc
2018-10-18Fix more broken links to the HID specChristoffer Holmberg2-2/+2
2018-10-18Fix grammar, typos, and the link to HID specificationChristoffer Holmberg1-7/+7
2018-10-16Fix doc typoJim Tittsler1-1/+1
2018-10-13Fix Typo in Custom Quantum functions document (led_state) (#4129)asakuno1-2/+2
*_LOCK 　　↓ DEL
generated by cgit v1.2.3-24-g4f1b (git 2.32.0) at 2024-11-25 09:38:43 +0100