yohan/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
4856552f8b
qmk_firmware/docs/_summary.md

107 lines
4.0 KiB
Markdown
Raw Normal View History

Add a newbie guide for people completely new to QMK (#2480)
2018-03-06 22:37:48 +00:00
* [Complete Newbs Guide](newbs.md)
* [Getting Started](newbs_getting_started.md)
* [Building Your First Firmware](newbs_building_firmware.md)
* [Flashing Firmware](newbs_flashing.md)
* [Testing and Debugging](newbs_testing_debugging.md)
[Docs] Smallish overhaul of the docs (#5281) * Fix up Common functions doc * Add to extra commands to flashing doc * Rearrange and touch up Macros * Expand Newbs Flashing guide * Update process_record documentation * Add git to best practices name in sidebar * Expand FAQ for build/flashing * Add deprecated info to functions * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/newbs_flashing.md Co-Authored-By: drashna <drashna@live.com> * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Update docs/faq_build.md Co-Authored-By: drashna <drashna@live.com> * Update docs/feature_macros.md Co-Authored-By: drashna <drashna@live.com> * Update docs/keymap.md Co-Authored-By: drashna <drashna@live.com> * Fix up Common functions doc * Make pre-init example accurate * Update docs/custom_quantum_functions.md Co-Authored-By: drashna <drashna@live.com> * Zadig Driver catchall * Spelling Depriciated * Completely remove fn_actions section
2019-03-18 21:22:02 +00:00
* [Git Best Practices](newbs_best_practices.md)
Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning 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-18 22:12:11 +00:00
* [Learning Resources](newbs_learn_more_resources.md)
Overhaul the Getting Started section and add a FAQ section
2017-08-06 03:54:34 +00:00
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
* [QMK Basics](README.md)
* [QMK Introduction](getting_started_introduction.md)
* [Contributing to QMK](contributing.md)
* [How to Use Github](getting_started_github.md)
* [Getting Help](getting_started_getting_help.md)
Overhaul the Getting Started section and add a FAQ section
2017-08-06 03:54:34 +00:00
* [FAQ](faq.md)
* [General FAQ](faq_general.md)
* [Build/Compile QMK](faq_build.md)
* [Debugging/Troubleshooting QMK](faq_debug.md)
* [Keymap](faq_keymap.md)
convert docs to lowercase and underscores
2017-06-10 18:58:55 +00:00
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
* Detailed Guides
* [Install Build Tools](getting_started_build_tools.md)
* [Vagrant Guide](getting_started_vagrant.md)
* [Build/Compile Instructions](getting_started_make_guide.md)
* [Flashing Firmware](flashing.md)
* [Customizing Functionality](custom_quantum_functions.md)
* [Keymap Overview](keymap.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Hardware](hardware.md)
* [AVR Processors](hardware_avr.md)
* [Drivers](hardware_drivers.md)
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
* Reference
* [Keyboard Guidelines](hardware_keyboard_guidelines.md)
* [Config Options](config_options.md)
* [Keycodes](keycodes.md)
* [Documentation Best Practices](documentation_best_practices.md)
* [Documentation Templates](documentation_templates.md)
* [Glossary](reference_glossary.md)
* [Unit Testing](unit_testing.md)
Helpful functions
2018-08-26 03:01:09 +00:00
* [Useful Functions](ref_functions.md)
Docs: Supporting a keyboard in the QMK Configurator (#4396) * 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-15 02:32:28 +00:00
* [Configurator Support](reference_configurator_support.md)
Address comments in #4832. Move info.json reference to its own file.
2019-01-14 18:38:22 +00:00
* [info.json Format](reference_info_json.md)
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
Update _summary.md
2017-07-17 19:01:33 +00:00
* [Features](features.md)
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
* [Basic Keycodes](keycodes_basic.md)
Re-order feature list in sidebar (#4555) 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-12-05 18:28:06 +00:00
* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
* [Quantum Keycodes](quantum_keycodes.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Advanced Keycodes](feature_advanced_keycodes.md)
* [Audio](feature_audio.md)
Fixed various feature links
2017-10-27 15:05:51 +00:00
* [Auto Shift](feature_auto_shift.md)
break up keymaps and quantum keycodes into files by feature
2017-08-07 00:51:42 +00:00
* [Backlight](feature_backlight.md)
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
* [Bluetooth](feature_bluetooth.md)
break up keymaps and quantum keycodes into files by feature
2017-08-07 00:51:42 +00:00
* [Bootmagic](feature_bootmagic.md)
Add documentation for Combo feature
2018-10-10 19:38:10 +00:00
* [Combos](feature_combo)
More thoroughly document Bootmagic and Command (#2455)
2018-03-02 17:21:03 +00:00
* [Command](feature_command.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Dynamic Macros](feature_dynamic_macros.md)
add support for encoders to core
2018-10-26 20:19:23 +00:00
* [Encoders](feature_encoders.md)
fix link for grave escape in docs
2017-12-03 11:49:11 +00:00
* [Grave Escape](feature_grave_esc.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Key Lock](feature_key_lock.md)
* [Layouts](feature_layouts.md)
Doc updates from going through every file
2017-08-07 03:57:57 +00:00
* [Leader Key](feature_leader_key.md)
Add LED Matrix to Features list for easy reference (#5280)
2019-03-03 23:29:29 +00:00
* [LED Matrix](feature_led_matrix.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Macros](feature_macros.md)
Convert all headings to Title Case
2017-12-09 05:36:32 +00:00
* [Mouse Keys](feature_mouse_keys.md)
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
Added Dichotemy Keyboard, updated docs for Pointing Device (#1817) * Added Dichotemy Keyboard, updated docs for Pointing Device * Updated readme * Updated mouse report pointer in pointing_device.c
2017-10-10 17:07:59 +00:00
* [Pointing Device](feature_pointing_device.md)
Convert all headings to Title Case
2017-12-09 05:36:32 +00:00
* [PS/2 Mouse](feature_ps2_mouse.md)
Fixed various feature links
2017-10-27 15:05:51 +00:00
* [RGB Lighting](feature_rgblight.md)
Fix sidebard doc
2018-07-16 17:49:09 +00:00
* [RGB Matrix](feature_rgb_matrix.md)
Docs: Format Space Cadet documentation (#3540) * Format Space Cadet documentation * Fix page filenames * Move Caveats section up
2018-08-01 15:43:54 +00:00
* [Space Cadet Shift](feature_space_cadet_shift.md)
* [Space Cadet Shift Enter](feature_space_cadet_shift_enter.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Stenography](feature_stenography.md)
Add back docs for hand-swapping feature.
2018-03-07 08:03:51 +00:00
* [Swap Hands](feature_swap_hands.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Tap Dance](feature_tap_dance.md)
Updates send_string functionality, adds terminal feature (#1657) * 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-09-12 04:43:10 +00:00
* [Terminal](feature_terminal.md)
Restructure the hardware and feature docs to make things easier to find (#1888) * fix #1313 by documenting more config.h options * Clean up and organize documentation
2017-10-25 03:34:28 +00:00
* [Thermal Printer](feature_thermal_printer.md)
* [Unicode](feature_unicode.md)
* [Userspace](feature_userspace.md)
Velocikey: Match RGB animation speed to typing speed (#3754) * 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-21 15:22:46 +00:00
* [Velocikey](feature_velocikey.md)
Link to steno docs from summary page.
2017-07-27 18:59:17 +00:00
Add missing files to _summary.md
2017-07-03 19:39:15 +00:00
* For Makers and Modders
update hand wiring link
2017-10-31 17:38:57 +00:00
* [Hand Wiring Guide](hand_wire.md)
Convert all headings to Title Case
2017-12-09 05:36:32 +00:00
* [ISP Flashing Guide](isp_flashing_guide.md)
ARM SWD guide - Added a detailed (but saddly long) debugging guide. - Modified sidebar and summary to include the links.
2018-10-04 21:37:26 +00:00
* [ARM Debugging Guide](arm_debugging.md)
I2C driver docs (#4298) * 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-11-10 20:26:39 +00:00
* [I2C Driver](i2c_driver.md)
Adds Proton C Conversion (#4661) * 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
2019-01-10 16:22:57 +00:00
* [GPIO Controls](internals_gpio_control.md)
* [Proton C Conversion](proton_c_conversion.md)
update the summary
2017-07-03 19:30:26 +00:00
Add missing files to _summary.md
2017-07-03 19:39:15 +00:00
* For a Deeper Understanding
Doc updates from going through every file
2017-08-07 03:57:57 +00:00
* [How Keyboards Work](how_keyboards_work.md)
update the summary
2017-07-03 19:30:26 +00:00
* [Understanding QMK](understanding_qmk.md)
Link to steno docs from summary page.
2017-07-27 18:59:17 +00:00
Add missing files to _summary.md
2017-07-03 19:39:15 +00:00
* Other Topics
[Docs] Add VSCode guide to docs (#5124) * Add VSCode guide to docs * Fix settings menu enumeration * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com> * Update docs/other_vscode.md Co-Authored-By: drashna <drashna@live.com>
2019-03-15 21:34:58 +00:00
* [Using Eclipse with QMK](other_eclipse.md)
* [Using VSCode with QMK](other_vscode.md)
Add support for PR and Issue templates to QMK_firmware GitHub (#4494) * 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-08 00:51:27 +00:00
* [Support](support.md)
Generate API docs from source code comments (#2491) * 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-22 06:50:38 +00:00
rename api docs to internals
2018-03-26 18:24:30 +00:00
* QMK Internals (In Progress)
* [Defines](internals_defines.md)
* [Input Callback Reg](internals_input_callback_reg.md)
* [Midi Device](internals_midi_device.md)
* [Midi Device Setup Process](internals_midi_device_setup_process.md)
* [Midi Util](internals_midi_util.md)
* [Send Functions](internals_send_functions.md)
* [Sysex Tools](internals_sysex_tools.md)
Reference in New Issue Copy Permalink