summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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
2018-08-30Mask off keycode/layer/mod where possible in LT(), MT(), etc. (#3430)fauxpark1-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
2018-08-29Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772)Evan Travers1-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.
2018-08-28ISSI31FL3733 driver (#3679)yiancar2-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.
2018-08-26Helpful functionsDrashna Jaelre4-0/+69
2018-08-16First pass at reorganizing docsskullY2-80/+56
2018-08-15Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660)zgtm1-2/+2
2018-08-12Document FIRMWARE_FORMAT (#3631)skullydazed1-0/+2
2018-08-11Update FAQ section on power keysfauxpark1-5/+4
2018-08-11Dedupe shifted keycodes listingfauxpark5-35/+5
2018-08-10RGB Driver Documentation Update (#3601)yiancar2-3/+7
- Minor formating in rgb matrix page - Added a short discription for is31fl3731 in drivers page
2018-08-07fix swap_hands keycodes in documentation (#3588)wanleg1-4/+4
2018-08-07Improve RGB lighting documentation (#3580)fauxpark1-121/+108
2018-08-05Update Shifted keycodes docs (#3575)fauxpark1-3/+5
2018-08-05Update FAQ section on Apple Fn (#3574)fauxpark1-5/+5
2018-08-04More improvements to keycode docs (#3567)fauxpark3-288/+324
* Reorder keycode list docs according to HID usage * Add missing keycodes/descriptions/aliases
2018-08-03Update ISP flashing guide with pre-compiled binary (#3217)Jack Humbert1-29/+50
* update flashing guide with pre-compiled binary * Add files via upload * Update isp_flashing_guide.md * update file and instructions * update instructions
2018-08-01Docs: Format Space Cadet documentation (#3540)fauxpark9-57/+71
* Format Space Cadet documentation * Fix page filenames * Move Caveats section up
2018-08-01Docs: Format Key Lock documentation (#3538)fauxpark1-7/+18
2018-08-01Docs: Fix some minor errors in tap dance example (#3530)Emmanuel Odongo1-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
2018-08-01Docs: Format Grave Escape documentation (#3536)fauxpark1-8/+15
2018-08-01Docs: Add Usage section to backlight docs (#3537)fauxpark1-3/+13
2018-07-31Backlighting docs (#3526)fauxpark1-19/+23
* Some words about backlighting * Link to RGB feature pages
2018-07-30Docs: Fix Command docs escaping (#3523)fauxpark1-32/+32
2018-07-29Docs: Adjust dynamic macro docs to include more than the planck (#3509)Evan Travers1-3/+3
2018-07-29Docs: Make Bootmagic and Command docs a little easier to read (#3499)fauxpark2-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
2018-07-27Docs: Clarify "right" -> "right-handed" (#3507)Evan Travers1-1/+1
I couldn't understand this sentence at first owing to the confusion between right meaning "correct," and right meaning "right-handed."
2018-07-27Docs: Fixed the link to the advanced keycodes wiki (#3505)Bruno Fagundez1-1/+1
2018-07-25Fix for the Split Common I2C code's SCL_CLOCK issue (#3474)Drashna Jaelre1-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
2018-07-17Update README with rules.mk ordering information.Fredric Silberberg1-1/+15
2018-07-17Lets split eh (#3120)That-Canadian2-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"
2018-07-17Fix sidebard docDrashna Jaelre2-4/+10
2018-07-16Docs: Adjust prompt to be more recognizable (#3417)Evan Travers1-6/+4
2018-07-15Overhaul to keycode related docsDrashna Jaelre5-90/+160
* Adds Audio Keycodes to both the feature page and master list * Re-orders the keycode list, so it's alphabetical (mostly) * Add additional (missing) sections to the keycode list * Add and update links in the keycode page * Add and reorder links in sidebar's keycode section
2018-07-15Integrating Peter Fleury's HD44780 LCD library (#3209)Max Audron2-0/+57
* integrated Peter Fleury's LCD library for HD44780 LCDs * fixed typo * cleanup finished * add documentation * added HD44780 documentation * removed keyboard from .gitmodules * resolved merge conflict * removed edit of kira75s rules.mk made by merge * moved hd44780 to drivers/avr * Added licence info to hd44780 files * Added link to hd44780 docs.
2018-07-15Update config.h boilerplate to use `#pragma once`Evan Travers1-11/+3
According to @fredizzimo, this is a safer and easier way to handle the boilerplate.
2018-07-15Add Userspace mentionEvan Travers1-0/+4
@drashna mentioned it'd be good to have a mention of the userspace in the QMK structure section. Rather than rewrite the docs on userspace, I chose to link to the existing documentation.
2018-07-15Reword the `config.h` sectionEvan Travers1-5/+16
This section didn't include the possibility of a user `config.h`, and it wasn't clear exactly how the settings override works.
2018-07-15Update docs: `Makefile` -> `rules.mk`Evan Travers1-1/+1
I think this was a typo, or perhaps an older way to handle it.
2018-07-13Docs: add resources for git (#3390)KeLorean2-1/+16
* add resources for git * add more resources
2018-07-11Replace gitter links with Discord. (#3368)Fred Silberberg3-11/+5
2018-07-08Instruct macos users to use avr-gcc@7 (#3337)Evan Travers2-1/+15
If you run `brew install avr-gcc`, you get a version that has compatibility issues with LUFA. I updated the getting started guide for osx, the qmk_install setup script, and added a section to the FAQ for folks like me who accidentally updated avr-gcc past 7.
2018-07-06Add documentation for TAPPING_FORCE_HOLD (#2957) (#3320)Nicolas Schodet2-3/+33
Also improve documentation for related settings.
2018-07-03Addition of hard brigtness limit for RGB_Matrix (#3299)yiancar1-0/+1
* Addition of hard brigtness limit for RGB_Matrix - Added a define "RGB_MATRIX_MAXIMUM_BRIGHTNESS" to enable hard limiting the maximum brightness for rgb_matrix - Used the above define to limit the maximum brigthness of HS60 for better stability * Added docs for new rgb_matrix define * Addition of check for maximum brightness
2018-06-28Clean up SEND_STRING keycodes and add media keys (#3214)fauxpark2-0/+2
* Clean up SEND_STRING keycodes and add media keys * Remove stray define * Add missing SEND_STRING keycodes for completeness Also, add KC_EJCT to the keycode references
generated by cgit v1.2.3-24-g4f1b (git 2.32.0) at 2024-05-12 03:16:42 +0200