summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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
2018-10-12add a notice into docs/feature_rgblight.mdmtei1-1/+2
2018-10-11Add documentation for Combo featureDrashna Jaelre4-0/+96
2018-10-11Cleanup learning newb linksDrashna Jaelre3-8/+8
2018-10-11Update and cleanup AVR Hardware docsDrashna Jaelre1-22/+20
2018-10-10Specify max layers supported in layer keycodesDrashna Jaelre1-2/+2
2018-10-09Fix formatting in Unicode textDrashna Jaelre1-5/+5
2018-10-09Added link to One Shot KeysBrian Choromanski1-1/+1
2018-10-09Added OSL to list of layer togglesBrian Choromanski1-0/+1
2018-10-07Update Bluetooth docs (#4062)chipperdoodles2-2/+34
* syncing upstream * Bluetooth Doc update More Description in bluetooth section, Addition to Config options rules.mk section. * merge upstream chibios * lib/chibios checkout * Additional EZ key Section added back EZ-Key diy link, Cleaned up some errors
2018-10-07Update and clarify Unicode documentation (#4065)Drashna Jaelre1-18/+89
* Update and clarify Unicode documentation * Fixed UCIS info based on feedback from algernon * Further clarifications and cleanup * Formatting * Add an example for unicode map * fix AutoHotKey title
2018-10-07Update Contrib doc (#4068)Drashna Jaelre1-2/+21
* Add link for style * ignore java * Add example and update link? * Minor fixes * Change 1TBS text * comments
2018-10-05ARM SWD guideyiancar3-0/+89
- Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links.
2018-10-02Add C hint to inline codeYan-Fa Li1-19/+19
2018-10-02Add send_unicode_hex_string function (#3828)Drashna Jaelre1-1/+6
* Add send_string_unicode function Co-authored-by: kdb424 <kdb424@gmail.com> Co-authored-by: Konstantin <vomindoraan@gmail.com> * Clean up code based on feedback * Fix includes
2018-10-02Add tap_code function (#3784)Drashna Jaelre1-0/+4
* Add tap_code * formatting * Doc clarification * Rename variable to make more consistent
2018-10-02Add Function level EECONFIG code for EEPROM (#3084)Drashna Jaelre1-0/+140
* Add Function level EEPROM configuration Add kb and user functions for EEPROM, and example of how to use it. * Bug fixes and demo * Additional cleanup * Add EEPROM reset macro to example * Forgot init function in list * Move eeconfig_init_quantum function to quantum.c and actually set default layer * See if removing weak quantum function fixes issue * Fix travis compile error * Remove ifdef blocks from EECONFIG so settings are always set * Fix for ARM EEPROM updates * Fix merge issues * Fix potential STM32 EEPROM issues
2018-10-01Make digital rain RGB matrix effect #define configurable.Daniel Shields1-0/+1
2018-10-01Correct small typoAnthony Som1-1/+1
A small typo (it -> in) that I noticed while reading through the documentation
2018-09-28Spell-check update for Userspace documentationnoroadsleft1-4/+4
Because leaving review comments on a PR that's already been merged doesn't make any sense.
2018-09-28Update quantum matrix to support both AVR and Chibios ARM (#3968)yiancar1-0/+23
* Update quantum matrix to support both AVR and Chibios ARM - Addition of STM32 pin definitions - Created abstruction layer defines to control GPIO (This is a bit pointless for Chibios as we are creating a PAL ontop of a PAL but it is necessary for uniformity with AVR) - Modified matrix.c to use the above functions * minor ifdef fix * Rename of functions and docs - Added documentation. - Renamed functions according to Jack's spec. * Massdrop fix * Update matrix.c * Update quantum.h * Update quantum.h * Update quantum.h * Update internals_gpio_control.md
2018-09-28Update to the Userspace documentation (#4005)Drashna Jaelre1-45/+133
* Overhaul to Userspace Documentation * Formatting issues * Additionaly formatting fixes * Add Readme info * Additionaly Readme info * Formatting fixes
2018-09-28Update Document Templates to reflect newer wording and URLs (#4006)Drashna Jaelre1-1/+1
* Add pragma once info to contributing guidelines * Fix links in readme template to match doc site * Revert changes to contributing doc as somebody already changed it
2018-09-28add 'mavrdude' target into tmk_core/avr.mk (#3986)Takeshi ISHII1-0/+6
* add 'mavrdude' target into tmk_core/avr.mk I made it a little convenient when writing the same binary to multiple Pro Micro. * rename target name 'mavrdude' to 'avrdude-loop' * modify docs/flashing.md about avrdude-loop * mdify docs/flashing.md again * modifi docs/flashing.md 3rd
2018-09-25Add On/Off keycodesDrashna Jaelre1-5/+7
2018-09-25Store Clicky status in EEPROMDrashna Jaelre1-3/+1
2018-09-23Circuitry sample for PS/2 Mouse (#3959)Luca1-0/+18
Added a sample circuitry for handling the connection of a PS/2 Mouse. Even if it's written that a circuitry is needed, there're a lot of other things and the information gets lost really fast. A really simple sample helps to remember who wants to implement the functionality about the circuitry.
2018-09-20Remove redefinition of `_______` in documentation example (#3924)Anthony Wharton1-3/+9
* Remove redefinition of `_______` in documentation example * Slight rewording to include purpose of defintions * Update include to newer macro
2018-09-18Create AG_TOGG code to toggle Alt/Gui swap.Joe Wasson2-0/+2
2018-09-17Fix LEADER_KEY docs.dsissitka1-1/+1
LEADER_KEY needs to be set in config.h, not keymap.c. Credit goes to @randywallace for figuring this one out: https://github.com/qmk/qmk_firmware/issues/2514#issuecomment-384847485
2018-09-17Make `PREVENT_STUCK_MODIFIERS` the default (#3107)Joe Wasson3-3/+11
* Remove chording as it is not documented, not used, and needs work. * Make Leader Key an optional feature. * Switch from `PREVENT_STUCK_MODIFIERS` to `STRICT_LAYER_RELEASE` * Remove `#define PREVENT_STUCK_MODIFIERS` from keymaps.
2018-09-15docs/contributing: add `#pragma once` to Coding ConventionsJames Laird-Wah1-0/+1
This supersedes the older include guard mechanism since all the compilers now support it. It's easier for new users and less prone to error.
2018-09-13Add an easy way to create new keymaps for your favorite keyboard (#3868)MechMerlin1-0/+14
* initial commit of keymap creation script * create default keymap * pass shellcheck * provide a better usage message * change printf string to more accurately reflect the path * make it more easily understood * found another typo * add documentation regarding the new_keymap script * enforce lowercase for userinputs
2018-09-13rgblight.[ch] more configurable (#3582)Takeshi ISHII1-15/+27
* add temporary test code rgblight-macro-test1.[ch] * rgblight.h : mode auto numberring and auto generate mode name symbol No change in build result. * rgblight.c use RGBLIGHT_MODE_xxx symbols No change in build result. * quantum.c use RGBLIGHT_MODE_xxx symbols No change in build result. * fix build break. when RGB_MATRIX_ENABLE defined * add temporary test code rgblight-macro-test2.[ch] * modify rgblight_mode_eeprom_helper() and rgblight_sethsv_eeprom_helper() * modify rgblight_task() * configurable each effect compile on/off in config.h * update docs/feature_rgblight.md * fix conflict. docs/feature_rgblight.md * remove temporary test code rgblight-macro-test*.[ch] * fix comment typo. * remove old mode number from comment * update docs/feature_rgblight.md about effect mode * Revert "update docs/feature_rgblight.md about effect mode" This reverts commit 43890663fcc9dda1899df7a37d382fc38b1a6d6d. * some change docs/feature_rgblight.md * fix typo * docs/feature_rgblight.md update: revise mode number table
2018-09-05Add the ability to disable the USB startup check for Chibiosyiancar1-0/+4
- Added support for NO_USB_STARTUP_CHECK. This allows the keyboard do function and not get stuck in a SUSPENDED state loop in case of no USB connection. - Added support for WAIT_FOR_USB. In LUFA no keyboard has this flag enable therefor no keyboard waits for usb to be active. - Added documentation for both configuration flags as they were missing.
2018-08-30Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs ↵fauxpark2-49/+69
(#3799)
2018-08-30Tweak the wording in "Becoming a QMK Collaborator"fauxpark1-4/+6
2018-08-30Docs: add process_terminal() and update links to other functions (#3778)arlenk1-24/+29
* add process_terminal() and update links to other functions * convert links to permalinks and add a few missing process_* functions * update links in main text as well
generated by cgit v1.2.3-24-g4f1b (git 2.32.0) at 2024-11-22 09:31:56 +0100