aboutsummaryrefslogtreecommitdiffstats
path: root/docs/_summary.md
Commit message (Collapse)AuthorAgeFilesLines
* Docs: Supporting a keyboard in the QMK Configurator (#4396)noroadsleft2018-11-141-0/+1
| | | | | | | | | | | | | | | | | | | | | | * 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
* I2C driver docs (#4298)yiancar2018-11-101-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | * 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
* add support for encoders to coreJack Humbert2018-10-261-0/+1
|
* Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning ↵noroadsleft2018-10-181-0/+2
| | | | | | | | | | | | | | | | | | | | | | 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
* Add documentation for Combo featureDrashna Jaelre2018-10-101-0/+1
|
* ARM SWD guideyiancar2018-10-051-0/+1
| | | | | - Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links.
* Helpful functionsDrashna Jaelre2018-08-261-0/+1
|
* First pass at reorganizing docsskullY2018-08-161-40/+28
|
* Dedupe shifted keycodes listingfauxpark2018-08-111-2/+1
|
* Docs: Format Space Cadet documentation (#3540)fauxpark2018-08-011-2/+2
| | | | | | | | * Format Space Cadet documentation * Fix page filenames * Move Caveats section up
* Fix sidebard docDrashna Jaelre2018-07-161-2/+4
|
* Overhaul to keycode related docsDrashna Jaelre2018-07-151-3/+7
| | | | | | | | * 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
* rename api docs to internalsJack Humbert2018-03-261-8/+8
|
* Generate API docs from source code comments (#2491)skullydazed2018-03-221-0/+9
| | | | | | | | | | | | | | | | | | * 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
* Disable the glossary linking to fix #2498 (#2499)skullydazed2018-03-081-1/+1
|
* Add back docs for hand-swapping feature.Joe Wasson2018-03-071-0/+1
|
* Add a newbie guide for people completely new to QMK (#2480)skullydazed2018-03-061-1/+8
|
* More thoroughly document Bootmagic and Command (#2455)skullydazed2018-03-021-0/+1
|
* Convert all headings to Title Casefauxpark2017-12-091-7/+7
|
* fix link for grave escape in docsBalz Guenat2017-12-081-1/+1
|
* Flesh out the grave escape overridesskullY2017-12-031-0/+1
|
* Fix internal links in docs/ (#2080)Devin J. Pohly2017-11-301-2/+1
| | | | 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.
* Move keycodes to their own sectionskullY2017-11-101-15/+16
|
* update hand wiring linkJack Humbert2017-10-311-1/+1
|
* Fixed various feature linksJeremy Cowgar2017-10-291-5/+7
|
* adds flashing docsJack Humbert2017-10-291-0/+1
|
* Restructure the hardware and feature docs to make things easier to find (#1888)skullydazed2017-10-241-23/+27
| | | | | | * fix #1313 by documenting more config.h options * Clean up and organize documentation
* Creates a userspace for keymaps (#1559)Jack Humbert2017-10-211-0/+1
| | | | | | | | | | * create a user space * adds example * document, add readme.md * jackhumbert userspace, ergodox keymap
* Fix the presentation of the contribution guideskullY2017-10-111-1/+1
|
* Write a contributing guide. (#1827)skullydazed2017-10-111-1/+2
|
* Added Dichotemy Keyboard, updated docs for Pointing Device (#1817)Snipeye2017-10-101-0/+1
| | | | | | | | * Added Dichotemy Keyboard, updated docs for Pointing Device * Updated readme * Updated mouse report pointer in pointing_device.c
* Updates send_string functionality, adds terminal feature (#1657)Jack Humbert2017-09-121-0/+1
| | | | | | | | | | | | | | | | | | | | | | * 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
* Creates a layouts/ folder for keymaps shared between keyboards (#1609)Jack Humbert2017-08-231-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* adds audio docs to summaryJack Humbert2017-08-181-0/+1
|
* Doc updates from going through every fileskullY2017-08-161-3/+5
|
* break up keymaps and quantum keycodes into files by featureskullY2017-08-161-11/+20
|
* rework key_functions into feature_common_shortcutsskullY2017-08-161-1/+6
|
* Overhaul the Getting Started section and add a FAQ sectionskullY2017-08-161-8/+11
|
* Added initial key lock documentation.Fredric Silberberg2017-08-081-0/+1
|
* Link to steno docs from summary page.Joe Wasson2017-07-271-3/+4
|
* Update _summary.mdJack Humbert2017-07-171-1/+1
|
* Add missing files to _summary.mdskullY2017-07-031-6/+9
|
* update the summaryskullY2017-07-031-1/+5
|
* Update a bunch of docsskullY2017-07-031-1/+2
|
* start glossaryJack Humbert2017-06-291-0/+1
|
* add file to summaryJack Humbert2017-06-291-0/+1
|
* Polish up custom_quantum_functionsskullY2017-06-291-1/+1
|
* use default base namesJack Humbert2017-06-291-2/+1
|
* testing out new homeJack Humbert2017-06-291-1/+1
|
* restructure summaryJack Humbert2017-06-291-31/+32
|