summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Spell-check update for Userspace documentationnoroadsleft2018-09-281-4/+4
| | | | Because leaving review comments on a PR that's already been merged doesn't make any sense.
* Update quantum matrix to support both AVR and Chibios ARM (#3968)yiancar2018-09-281-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
* Update to the Userspace documentation (#4005)Drashna Jaelre2018-09-281-45/+133
| | | | | | | | | | | | | | * Overhaul to Userspace Documentation * Formatting issues * Additionaly formatting fixes * Add Readme info * Additionaly Readme info * Formatting fixes
* Update Document Templates to reflect newer wording and URLs (#4006)Drashna Jaelre2018-09-281-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
* add 'mavrdude' target into tmk_core/avr.mk (#3986)Takeshi ISHII2018-09-271-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
* Add On/Off keycodesDrashna Jaelre2018-09-251-5/+7
|
* Store Clicky status in EEPROMDrashna Jaelre2018-09-251-3/+1
|
* Circuitry sample for PS/2 Mouse (#3959)Luca2018-09-231-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.
* Remove redefinition of `_______` in documentation example (#3924)Anthony Wharton2018-09-191-3/+9
| | | | | | | | * Remove redefinition of `_______` in documentation example * Slight rewording to include purpose of defintions * Update include to newer macro
* Create AG_TOGG code to toggle Alt/Gui swap.Joe Wasson2018-09-172-0/+2
|
* Fix LEADER_KEY docs.dsissitka2018-09-171-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
* Make `PREVENT_STUCK_MODIFIERS` the default (#3107)Joe Wasson2018-09-173-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.
* docs/contributing: add `#pragma once` to Coding ConventionsJames Laird-Wah2018-09-151-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.
* Add an easy way to create new keymaps for your favorite keyboard (#3868)MechMerlin2018-09-131-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
* rgblight.[ch] more configurable (#3582)Takeshi ISHII2018-09-131-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
* Add the ability to disable the USB startup check for Chibiosyiancar2018-09-051-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.
* Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs ↵fauxpark2018-08-302-49/+69
| | | | (#3799)
* Tweak the wording in "Becoming a QMK Collaborator"fauxpark2018-08-301-4/+6
|
* Docs: add process_terminal() and update links to other functions (#3778)arlenk2018-08-291-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
* Mask off keycode/layer/mod where possible in LT(), MT(), etc. (#3430)fauxpark2018-08-291-6/+4
| | | | | | | | * Mask off keycode/layer/mod where possible in LT(), MT(), etc. * Don't need these parentheses * Put back parentheses for order of operations
* Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772)Evan Travers2018-08-281-0/+6
| | | | | | | When moving my planck layout to my let's split, I ran into this issue because I had copied my planck layout from the default layout which just used the `{}` array form for the keymap layers. I checked the docs, but this bit wasn't clear to me. I'm sure @ishtob or @drashna helped me on discord, but this seemed to be the logical place to add a helpful hint.
* ISSI31FL3733 driver (#3679)yiancar2018-08-282-3/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * ISSI31FL3733 driver - Addapted IS31 driver for the above driver * fix my branch * ISSI31FL3733 driver - Inclusion of above ISSI led driver * IS31fl3733 driver - Added correct function for control registers * Finalized support for ISSI31fl3733 led driver - Finalized and tested driver. - Modified i2c_master for arm due to declaration mistake. - Fixed spaces/tabs in quantum.h file. - Fixed spaces/tabs in common_features.mk file. - Removed unnecessary includes from rgb_matrix.c file. - Added local definitions for MIN and MAX macros in rgb_matrix.c file. - Adjusted chevron effect. - Added necessary define (RGB_3733_MATRIX_ENABLE) for makefile. - Added necessary C define (ISSI3733) to aid with inclusion of the correct header file. - Added documentation for the new driver. * Driver structure update - Changed rule includes to be more condensed (RGB_MATRIX_ENABLE = IS31FL3731) and (RGB_MATRIX_ENABLE = IS31FL3733) - Updated documentation - Reverted to the use of differently named functions for each driver and selecting the needed ones within rgb_matrix.c * ISSI Drivers refractoring - Moved issi drivers in a dedicated folder - Updated documentation * I2C library fix I released the special pins incorrectly before. It is now fixed.
* Helpful functionsDrashna Jaelre2018-08-264-0/+69
|
* First pass at reorganizing docsskullY2018-08-162-80/+56
|
* Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660)zgtm2018-08-151-2/+2
|
* Document FIRMWARE_FORMAT (#3631)skullydazed2018-08-111-0/+2
|
* Update FAQ section on power keysfauxpark2018-08-111-5/+4
|
* Dedupe shifted keycodes listingfauxpark2018-08-115-35/+5
|
* RGB Driver Documentation Update (#3601)yiancar2018-08-092-3/+7
| | | | - Minor formating in rgb matrix page - Added a short discription for is31fl3731 in drivers page
* fix swap_hands keycodes in documentation (#3588)wanleg2018-08-071-4/+4
|
* Improve RGB lighting documentation (#3580)fauxpark2018-08-071-121/+108
|
* Update Shifted keycodes docs (#3575)fauxpark2018-08-051-3/+5
|
* Update FAQ section on Apple Fn (#3574)fauxpark2018-08-051-5/+5
|
* More improvements to keycode docs (#3567)fauxpark2018-08-043-288/+324
| | | | | | * Reorder keycode list docs according to HID usage * Add missing keycodes/descriptions/aliases
* Update ISP flashing guide with pre-compiled binary (#3217)Jack Humbert2018-08-021-29/+50
| | | | | | | | | | | | * update flashing guide with pre-compiled binary * Add files via upload * Update isp_flashing_guide.md * update file and instructions * update instructions
* Docs: Format Space Cadet documentation (#3540)fauxpark2018-08-019-57/+71
| | | | | | | | * Format Space Cadet documentation * Fix page filenames * Move Caveats section up
* Docs: Format Key Lock documentation (#3538)fauxpark2018-07-311-7/+18
|
* Docs: Fix some minor errors in tap dance example (#3530)Emmanuel Odongo2018-07-311-10/+8
| | | | | | | | | | | | | * Fix some minor errors in tap dance example Fix for #3529 Fix minor errors in the code examples for __Example 4: 'Quad Function Tap-Dance'__ and relevant documentation. Clarified the need to include the header file in `keymap.c`. * Use #pragma once in header guard Fix for #3529 Implement change requested in #3530
* Docs: Format Grave Escape documentation (#3536)fauxpark2018-07-311-8/+15
|
* Docs: Add Usage section to backlight docs (#3537)fauxpark2018-07-311-3/+13
|
* Backlighting docs (#3526)fauxpark2018-07-301-19/+23
| | | | | | * Some words about backlighting * Link to RGB feature pages
* Docs: Fix Command docs escaping (#3523)fauxpark2018-07-291-32/+32
|
* Docs: Adjust dynamic macro docs to include more than the planck (#3509)Evan Travers2018-07-291-3/+3
|
* Docs: Make Bootmagic and Command docs a little easier to read (#3499)fauxpark2018-07-292-118/+127
| | | | | | | | * Make Bootmagic and Command docs a little easier to read * Sometimes Bootmagic/Command is default on * "Escape" pipe character so it renders correctly
* Docs: Clarify "right" -> "right-handed" (#3507)Evan Travers2018-07-261-1/+1
| | | | I couldn't understand this sentence at first owing to the confusion between right meaning "correct," and right meaning "right-handed."
* Docs: Fixed the link to the advanced keycodes wiki (#3505)Bruno Fagundez2018-07-261-1/+1
|
* Fix for the Split Common I2C code's SCL_CLOCK issue (#3474)Drashna Jaelre2018-07-251-0/+2
| | | | | | | | | | | * Fix the SLC_CLOCK setting for the Split Common code Make the SCL_CLOCK setting configurable per board, since some use different settings And change the Iris to use 100000L instead of 400000L * Add SCL_CLOCK variable to documentation * Change SCL_CLOCK default to 100000L
* Update README with rules.mk ordering information.Fredric Silberberg2018-07-171-1/+15
|
* Lets split eh (#3120)That-Canadian2018-07-162-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Line ending stuff again * Added Let's Split Eh? Files and updated #USE_IC2 checks to also include th EH revision (can only be used in I2C) * Added personal keymap, updated some of the EH files * Created new keyboard file for testing "lets_split_eh" will merge into lets_split once fully functional * Added split code from lets_split, removed pro micro imports and LED code THIS IS WORKING CODE, WITHOUT RGB AND BACKLIGHT * Took back original Lets Slit files for the lets_split keyboard, working in the lets_split_eh folder for now * Updated eh.c * More rework of the I2C code, added global flags for split boards. * Introduced RGB over I2C, having weird edge case issues at the moment though * Fixed weird I2C edgecase with RGB, although still would like to track down route cause.. * Changed RGB keycodes (static ones) to activate on key-up instead of key-down to elimate weird ghosting issue over I2C * Lots of changes, mainly externalized the Split keyboard code and added logic for only including when needed. - Added makefile option "SPLIT_KEYBOARD" that when = yes will include the split keyboard files and custom matrix - Split keyboard files placed into quantum/split_common/ - Added define option for config files "SPLIT_HAND_PIN" FOr using high/low pin to determine handedness, low = right hand, high = left hand - Cleaned up split logic for RGB and Backlight so it is only exectuted / included when needed * Updated documentation for the new makefile options and #defines specific to split keyboards * Added a bit more info to docs, so people aren't confused * Modifed Let's Split to use externalized code, also added left and right hand eeprom files to the split_common folder * Removed some debugging from eh.c * Small changes to keyboard configs. Also added a default keymap (just a copy of my that_canadian keymap). * Added a README file to the Let's Split Eh? * Changed it so RGB static updates are done on key-up ONLY for split boards rather than all boards. Also fixed leftover un-used variable in rgblight.c * Updated default keymap and my keymap for Let's Split Eh? Updated the comments so it reflects RGB control, and removed audio functions. * Fixed lets_split_eh not having a default version * Removed "eh" references from lets_split folder for now * Took lets_split folder from master to fix travis build errors, weird my local was overriding. * Changed LAYOUT_ortho_4x12_kc -> LAYOUT_kc_ortho_4x12 to match bakingpy and others * Removed rules.mk from my lets_split keymap, not needed * Updated the config_options doc to better explain the usage of "#define SPLIT_HAND_PIN"
* Fix sidebard docDrashna Jaelre2018-07-162-4/+10
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-20 03:39:53 +0000