aboutsummaryrefslogtreecommitdiffstats
path: root/docs/_summary.md
AgeCommit message (Collapse)Author
2019-03-03Add LED Matrix to Features list for easy reference (#5280)Gravatar Drashna Jaelre
2019-02-21Velocikey: Match RGB animation speed to typing speed (#3754)Gravatar Chris Lewis
* Draft commit of typing speed RGB control * More information in the readme * Support all RGB animation modes (Fixes #1) * Added support for all RGB light modes to use typing speed Except christmas lights because that is seizure-inducing at high speeds! * Introduced a value range specific to each RGB mode Because some modes are a little too much when running at full speed! * Update readme.md * Update readme.md * Re-arrange typing_speed definitions (Fixes #5) (#6) * Re-arrange variable definitions to avoid including quantum.h from rgblight.c * Fix a compilation error when trying to run make test:all * Tweaks to the typing speed decay rate * Renamed to momentum; moved implementation into dedicated files * Groundwork for toggling momentum on/off (currently always on) * Add EEPROM toggle for momentum-matching * Moved momentum out of RGBLIGHT_ENABLE toggles so it's more generic * Move momentum decay task out of rgblight_task() * Fix missing momentum.h in lufa.c * Experimental LED support (untested) * Draft commit of typing speed RGB control * More information in the readme * Support all RGB animation modes (Fixes #1) * Added support for all RGB light modes to use typing speed Except christmas lights because that is seizure-inducing at high speeds! * Introduced a value range specific to each RGB mode Because some modes are a little too much when running at full speed! * Update readme.md * Update readme.md * Re-arrange typing_speed definitions (Fixes #5) (#6) * Re-arrange variable definitions to avoid including quantum.h from rgblight.c * Fix a compilation error when trying to run make test:all * Tweaks to the typing speed decay rate * Renamed to momentum; moved implementation into dedicated files * Groundwork for toggling momentum on/off (currently always on) * Add EEPROM toggle for momentum-matching * Moved momentum out of RGBLIGHT_ENABLE toggles so it's more generic * Move momentum decay task out of rgblight_task() * Fix missing momentum.h in lufa.c * Added documentation * Renamed feature to velocikey * Reverted readme to original state * Correct the readme title * Updated feature name in the docs * Update EECONFIG name * Add compile-time toggles for velocikey * Update feature documentation * Revert "Merge branch 'led-support' into master" This reverts commit e123ff5febf61639b9a9020748e1c2e2313460ff, reversing changes made to df111a55b9d4929182e16108b1c0ead15b16df97. * Move velocikey EECONFIG definition to depend on VELOCIKEY_ENABLE * Rename decay_task function to decelerate * Apply suggestions from code review Co-Authored-By: chrislewisdev <chris@chrislewisdev.com> * Re-order eeconfig definitions * Apply coding conventions * Apply #ifdef check in lufa.c * Refactored interval time checks into one functionc * Small rename * Fix unused function error for layouts not using all rgb effects * Only update EEPROM if Velocikey is enabled * Incorporate code review feedback * Small adjustment to top-end decay rate * Add Velocikey documentation to table of contents * Bring tetris:default keymap size down by disabling audio
2019-02-08Address comments in #4832. Move info.json reference to its own file.Gravatar skullY
2019-01-10Adds Proton C Conversion (#4661)Gravatar Jack Humbert
* adds proton c base * fixes custom matrix include * adds readme.md * initial proton coversion, no pin mapping * start of mcu selection * add pin mapping and sweet16 test * add at90 to list * disable backlight, fix d7 * update flag names * doc updates * proton c update for mcu selection
2018-12-07Add support for PR and Issue templates to QMK_firmware GitHub (#4494)Gravatar Drashna Jaelre
* 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 * Minor tweaks * More minor tweaks * Spleeling fix Co-Authored-By: drashna <drashna@live.com> * CapiTALization fIXes Co-Authored-By: drashna <drashna@live.com> * Use new issue URL Co-Authored-By: drashna <drashna@live.com> * Add blanck issue template * Update the PR template * Formatting and additional changes * Update docs/support.md Co-Authored-By: drashna <drashna@live.com>
2018-12-05Re-order feature list in sidebar (#4555)Gravatar Drashna Jaelre
Specifically, moved the shifted keycodes to the top of the 'Feature' list, so it's more visible. This way, all of the keycodes are at the top of the list, rather than having the shifted keys at the bottom, so they should be easier to find since they're all in one place.
2018-11-14Docs: Supporting a keyboard in the QMK Configurator (#4396)Gravatar noroadsleft
* 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-10I2C driver docs (#4298)Gravatar yiancar
* 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-10-26add support for encoders to coreGravatar Jack Humbert
2018-10-18Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning ↵Gravatar noroadsleft
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-10Add documentation for Combo featureGravatar Drashna Jaelre
2018-10-05ARM SWD guideGravatar yiancar
- Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links.
2018-08-26Helpful functionsGravatar Drashna Jaelre
2018-08-16First pass at reorganizing docsGravatar skullY
2018-08-11Dedupe shifted keycodes listingGravatar fauxpark
2018-08-01Docs: Format Space Cadet documentation (#3540)Gravatar fauxpark
* Format Space Cadet documentation * Fix page filenames * Move Caveats section up
2018-07-16Fix sidebard docGravatar Drashna Jaelre
2018-07-15Overhaul to keycode related docsGravatar Drashna Jaelre
* 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-03-26rename api docs to internalsGravatar Jack Humbert
2018-03-22Generate API docs from source code comments (#2491)Gravatar skullydazed
* Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly
2018-03-08Disable the glossary linking to fix #2498 (#2499)Gravatar skullydazed
2018-03-07Add back docs for hand-swapping feature.Gravatar Joe Wasson
2018-03-06Add a newbie guide for people completely new to QMK (#2480)Gravatar skullydazed
2018-03-02More thoroughly document Bootmagic and Command (#2455)Gravatar skullydazed
2017-12-09Convert all headings to Title CaseGravatar fauxpark
2017-12-08fix link for grave escape in docsGravatar Balz Guenat
2017-12-03Flesh out the grave escape overridesGravatar skullY
2017-11-30Fix internal links in docs/ (#2080)Gravatar Devin J. Pohly
One link in the summary (Modding your keyboard) referred to a page that was deleted; the rest have been updated to point to the new names.
2017-11-10Move keycodes to their own sectionGravatar skullY
2017-10-31update hand wiring linkGravatar Jack Humbert
2017-10-29Fixed various feature linksGravatar Jeremy Cowgar
2017-10-29adds flashing docsGravatar Jack Humbert
2017-10-24Restructure the hardware and feature docs to make things easier to find (#1888)Gravatar skullydazed
* fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-21Creates a userspace for keymaps (#1559)Gravatar Jack Humbert
* create a user space * adds example * document, add readme.md * jackhumbert userspace, ergodox keymap
2017-10-11Fix the presentation of the contribution guideGravatar skullY
2017-10-11Write a contributing guide. (#1827)Gravatar skullydazed
2017-10-10Added Dichotemy Keyboard, updated docs for Pointing Device (#1817)Gravatar Snipeye
* Added Dichotemy Keyboard, updated docs for Pointing Device * Updated readme * Updated mouse report pointer in pointing_device.c
2017-09-12Updates send_string functionality, adds terminal feature (#1657)Gravatar Jack Humbert
* implement basic terminal stuff * modify send_string to read normal strings too * add files bc yeah. working pgm detected * pgm detection apparently not working * adds send string keycodes, additional keycode support in send string * implement arguments * [terminal] add help command * [terminal] adds keycode and keymap functions * [terminal] adds nop.h, documentation * update macro docs
2017-08-23Creates a layouts/ folder for keymaps shared between keyboards (#1609)Gravatar Jack Humbert
* include variables and .h files as pp directives * start layout compilation * split ergodoxes up * don't compile all layouts for everything * might seg fault * reset layouts variable * actually reset layouts * include rules.mk instead * remove includes from rules.mk * update variable setting * load visualizer from path * adds some more examples * adds more layouts * more boards added * more boards added * adds documentation for layouts * use lowercase names for LAYOUT_ * add layout.json files for each layout * add community folder, default keymaps for layouts * touch-up default layouts * touch-up layouts, some keyboard rules.mk * update documentation for layouts * fix up serial/i2c switches
2017-08-18adds audio docs to summaryGravatar Jack Humbert
2017-08-16Doc updates from going through every fileGravatar skullY
2017-08-16break up keymaps and quantum keycodes into files by featureGravatar skullY
2017-08-16rework key_functions into feature_common_shortcutsGravatar skullY
2017-08-16Overhaul the Getting Started section and add a FAQ sectionGravatar skullY
2017-08-08Added initial key lock documentation.Gravatar Fredric Silberberg
2017-07-27Link to steno docs from summary page.Gravatar Joe Wasson
2017-07-17Update _summary.mdGravatar Jack Humbert
2017-07-03Add missing files to _summary.mdGravatar skullY
2017-07-03update the summaryGravatar skullY
2017-07-03Update a bunch of docsGravatar skullY
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-12-27 18:02:08 +0000