fern/qmk-firmware
1
0
Fork 0
mirror of https://github.com/firewalkwithm3/qmk_firmware.git synced 2024-11-22 19:40:29 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
qmk-firmware/docs/_summary.md

126 lines
4.8 KiB
Markdown
Raw Normal View History

Add a newbie guide for people completely new to QMK (#2480)
2018-03-07 06:37:48 +08:00
* [Complete Newbs Guide](newbs.md)
wip
2020-02-21 03:06:27 +08:00
* [Introduction](newbs_getting_started.md)
Add a newbie guide for people completely new to QMK (#2480)
2018-03-07 06:37:48 +08:00
* [Building Your First Firmware](newbs_building_firmware.md)
* [Flashing Firmware](newbs_flashing.md)
* [Testing and Debugging](newbs_testing_debugging.md)
wip
2020-02-21 03:06:27 +08:00
* [Getting Help](getting_started_getting_help.md)
* Guides
* [ARM Debugging Guide](arm_debugging.md)
[Docs] Restructure of Git Best Practices doc (#7231) * Add "Resynchronizing an Out-of-Sync Git Branch" doc * Update (Git) Best Practices doc title and filename * Rename Branch Resync doc * fork Best Practices doc into multiple files * Add the doc list to Git Best Practices doc * Update sidebar * Update internal references * Update sidebar - add subsection * Update Your Fork's Master page title * title case on Git Best Practices main doc * ... and in the Resynchronizing a Branch doc * Please read Part 1 I worked really hard on this, okay? * Please use branches, too. * suggestions by mtei * change note about adding multiple files * note that the name given the remote repo is arbitrary * suggestions by fauxpark * Git Best Practices -> Best Git Practices Reads more naturally. * rephrase hint block regarding remote name * rework the resynchronization instructions per mtei * use hint boxes for reference to Part 1 doc I may be addicted to hint boxes. I'm sorry fauxpark. :cry: * add some clarity about the upstream repo * wordsmithing per mtei * restyle the shell code blocks Makes them more consistent to the other docs in this section.
2019-12-03 10:47:02 +08:00
* [Best Git Practices](newbs_git_best_practices.md)
wip
2020-02-21 03:06:27 +08:00
* [Contributing to QMK](contributing.md)
* [Customizing Functionality](custom_quantum_functions.md)
* [Github Best Practices](getting_started_github.md)
* [Hand Wiring Guide](hand_wire.md)
* [ISP Flashing Guide](isp_flashing_guide.md)
* [Flashing Firmware](flashing.md)
* [Keymap Overview](keymap.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-19 06:12:11 +08:00
* [Learning Resources](newbs_learn_more_resources.md)
QMK CLI and JSON keymap support (#6176) * Script to generate keymap.c from JSON file. * Support for keymap.json * Add a warning about the keymap.c getting overwritten. * Fix keymap generating * Install the python deps * Flesh out more of the python environment * Remove defunct json2keymap * Style everything with yapf * Polish up python support * Hide json keymap.c into the .build dir * Polish up qmk-compile-json * Make milc work with positional arguments * Fix a couple small things * Fix some errors and make the CLI more understandable * Make the qmk wrapper more robust * Add basic QMK Doctor * Clean up docstrings and flesh them out as needed * remove unused compile_firmware() function
2019-07-16 03:14:27 +08:00
* [QMK CLI](cli.md)
wip
2020-02-21 03:06:27 +08:00
* [Vagrant Guide](getting_started_vagrant.md)
First pass at reorganizing docs
2018-08-12 05:54:27 +08:00
Merge point for 2019 Aug 30 Breaking Change
2019-08-31 03:04:09 +08:00
* [Breaking Changes](breaking_changes.md)
change Instructions listing in Docs summary
2020-01-26 06:03:26 +08:00
* [My Pull Request Was Flagged](breaking_changes_instructions.md)
Merge point for 2019 Aug 30 Breaking Change
2019-08-31 03:04:09 +08:00
* [2019 Aug 30](ChangeLog/20190830.md)
Overhaul the Getting Started section and add a FAQ section
2017-08-06 11:54:34 +08: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)
Add Zadig 101 to docs (#6585) * Add Zadig 101 to docs * Add USBasp bootloader name * Add links to the page * Note the usual VIDs and PIDs for the bootloaders * Add "List All Devices" note, just in case * Talk about keyboard-specific bootloader procedures * Send users to the new page in "Unknown Device for DFU Bootloader" section * Halfkay bootloaders are also an exception here
2019-08-24 14:38:21 +08:00
* [Driver Installation with Zadig](driver_installation_zadig.md)
convert docs to lowercase and underscores
2017-06-11 02:58:55 +08:00
wip
2020-02-21 03:06:27 +08:00
* QMK Features
* [Keycodes](keycodes.md)
* [Basic Keycodes](keycodes_basic.md)
* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
* [Quantum Keycodes](quantum_keycodes.md)
* [Advanced Keycodes](feature_advanced_keycodes.md)
* [Auto Shift](feature_auto_shift.md)
* Software Features
* [Combos](feature_combo.md)
* [Command](feature_command.md)
* [Debounce API](feature_debounce_type.md)
* [Dynamic Macros](feature_dynamic_macros.md)
* [Grave Escape](feature_grave_esc.md)
* [Key Lock](feature_key_lock.md)
* [Leader Key](feature_leader_key.md)
* [Macros](feature_macros.md)
* [Mouse Keys](feature_mouse_keys.md)
* [One Shot Keys](feature_advanced_keycodes.md#one-shot-keys)
* [Pointing Device](feature_pointing_device.md)
* [Space Cadet](feature_space_cadet.md)
* [Swap Hands](feature_swap_hands.md)
* [Tap Dance](feature_tap_dance.md)
* [Terminal](feature_terminal.md)
* [Unicode](feature_unicode.md)
* [Userspace](feature_userspace.md)
* Hardware Features
* [Audio](feature_audio.md)
* [Backlight](feature_backlight.md)
* [Bluetooth](feature_bluetooth.md)
* [Bootmagic](feature_bootmagic.md)
* [Custom Matrix](custom_matrix.md)
* [DIP Switch](feature_dip_switch.md)
* [Encoders](feature_encoders.md)
* [Haptic Feedback](feature_haptic_feedback.md)
* [HD44780 LCD Controller](feature_hd44780.md)
* [LED Matrix](feature_led_matrix.md)
* [OLED Driver](feature_oled_driver.md)
* [Proton C Conversion](proton_c_conversion.md)
* [PS/2 Mouse](feature_ps2_mouse.md)
* [RGB Lighting](feature_rgblight.md)
* [RGB Matrix](feature_rgb_matrix.md)
* [Split Keyboard](feature_split_keyboard.md)
* [Stenography](feature_stenography.md)
* [Thermal Printer](feature_thermal_printer.md)
* [Velocikey](feature_velocikey.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 11:34:28 +08:00
wip
2020-02-21 03:06:27 +08:00
* QMK Reference
First pass at reorganizing docs
2018-08-12 05:54:27 +08:00
* [Config Options](config_options.md)
wip
2020-02-21 03:06:27 +08:00
* [Make Documentation](getting_started_make_guide.md)
First pass at reorganizing docs
2018-08-12 05:54:27 +08:00
* [Documentation Best Practices](documentation_best_practices.md)
* [Documentation Templates](documentation_templates.md)
* [Glossary](reference_glossary.md)
wip
2020-02-21 03:06:27 +08:00
* [Community Layouts](feature_layouts.md)
First pass at reorganizing docs
2018-08-12 05:54:27 +08:00
* [Unit Testing](unit_testing.md)
Helpful functions
2018-08-26 11:01:09 +08: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 10:32:28 +08:00
* [Configurator Support](reference_configurator_support.md)
Address comments in #4832. Move info.json reference to its own file.
2019-01-15 02:38:22 +08:00
* [info.json Format](reference_info_json.md)
First pass at reorganizing docs
2018-08-12 05:54:27 +08:00
wip
2020-02-21 03:06:27 +08:00
* C Development
* [AVR Processors](hardware_avr.md)
* [Coding Conventions](coding_conventions_c.md)
* [Compatible Microcontrollers](compatible_microcontrollers.md)
* [Drivers](hardware_drivers.md)
* [ADC Driver](adc_driver.md)
* [I2C Driver](i2c_driver.md)
* [WS2812 Driver](ws2812_driver.md)
* [EEPROM Driver](eeprom_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-11 00:22:57 +08:00
* [GPIO Controls](internals_gpio_control.md)
wip
2020-02-21 03:06:27 +08:00
* [Keyboard Guidelines](hardware_keyboard_guidelines.md)
* Python Development
* [Coding Conventions](coding_conventions_python.md)
* [QMK CLI Config](cli_configuration.md)
* [Python CLI Development](cli_development.md)
update the summary
2017-07-04 03:30:26 +08:00
Add missing files to _summary.md
2017-07-04 03:39:15 +08:00
* For a Deeper Understanding
Doc updates from going through every file
2017-08-07 11:57:57 +08:00
* [How Keyboards Work](how_keyboards_work.md)
update the summary
2017-07-04 03:30:26 +08:00
* [Understanding QMK](understanding_qmk.md)
Link to steno docs from summary page.
2017-07-28 02:59:17 +08:00
Add missing files to _summary.md
2017-07-04 03:39:15 +08: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-16 05:34:58 +08: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 08:51:27 +08:00
* [Support](support.md)
Set up language fallback for docs, and update translation guidelines (#7403) * Set up language fallback for docs, and update translation guidelines * Title Case * Add ID example * Link to emoji flag cheatsheet * Move docs preview section to contributing.md * Point to docs preview in the readme
2019-11-24 00:07:15 +08:00
* [Translating the QMK Docs](translating.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 14:50:38 +08:00
rename api docs to internals
2018-03-27 02:24:30 +08: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 a new issue Copy permalink