mirrors/qmk_firmware
1
0
Fork 1
mirror of https://github.com/qmk/qmk_firmware synced 2024-11-18 09:55:48 +00:00
Code Issues Projects Releases Packages Wiki Activity
qmk_firmware/docs/_summary.md

180 lines
6.6 KiB
Markdown
Raw Normal View History

overhaul the newbs guide
2020-02-25 18:58:36 +00:00
* Tutorial
more wip
2020-02-20 19:57:43 +00:00
* [Introduction](newbs.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Setup](newbs_getting_started.md)
Add a newbie guide for people completely new to QMK (#2480)
2018-03-06 22:37:48 +00:00
* [Building Your First Firmware](newbs_building_firmware.md)
* [Flashing Firmware](newbs_flashing.md)
* [Testing and Debugging](newbs_testing_debugging.md)
make sure all our redirects are in order
2020-03-01 16:57:26 +00:00
* [Getting Help/Support](support.md)
rearrange the sidebar a bit
2020-02-26 00:33:56 +00:00
* [Other Resources](newbs_learn_more_resources.md)
Add a syllabus to guide people who are learning QMK (#8816)
2020-04-19 07:08:38 +00:00
* [Syllabus](syllabus.md)
wip
2020-02-20 19:06:27 +00:00
more wip
2020-02-20 19:57:43 +00:00
* FAQs
Overhaul the Getting Started section and add a FAQ section
2017-08-06 03:54:34 +00:00
* [General FAQ](faq_general.md)
* [Build/Compile QMK](faq_build.md)
* [Debugging/Troubleshooting QMK](faq_debug.md)
improve our docsify setup
2020-02-25 21:43:05 +00:00
* [Keymap FAQ](faq_keymap.md)
* [Glossary](reference_glossary.md)
convert docs to lowercase and underscores
2017-06-10 18:58:55 +00:00
Add API documentation
2020-02-24 06:37:25 +00:00
* Configurator
* [Overview](newbs_building_firmware_configurator.md)
overhaul the newbs guide
2020-02-25 18:58:36 +00:00
* [Step by Step](configurator_step_by_step.md)
* [Troubleshooting](configurator_troubleshooting.md)
Add API documentation
2020-02-24 06:37:25 +00:00
* QMK API
* [Overview](api_overview.md)
* [API Documentation](api_docs.md)
overhaul the newbs guide
2020-02-25 18:58:36 +00:00
* [Keyboard Support](reference_configurator_support.md)
[Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049)
2020-10-17 16:50:32 +00:00
* [Adding Default Keymaps](configurator_default_keymaps.md)
Add API documentation
2020-02-24 06:37:25 +00:00
More sidebar organization
2020-02-25 17:17:24 +00:00
* CLI
* [Overview](cli.md)
* [Configuration](cli_configuration.md)
* [Commands](cli_commands.md)
more wip
2020-02-20 19:57:43 +00:00
* Using QMK
* Guides
* [Customizing Functionality](custom_quantum_functions.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Driver Installation with Zadig](driver_installation_zadig.md)
more wip
2020-02-20 19:57:43 +00:00
* [Keymap Overview](keymap.md)
Reintegrate previous docker docs (#9084)
2020-05-20 04:54:55 +00:00
* Development Environments
* [Docker Guide](getting_started_docker.md)
* [Vagrant Guide](getting_started_vagrant.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* Flashing
overhaul the newbs guide
2020-02-25 18:58:36 +00:00
* [Flashing](flashing.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Flashing ATmega32A (ps2avrgb)](flashing_bootloadhid.md)
rearrange the sidebar a bit
2020-02-26 00:33:56 +00:00
* IDEs
* [Using Eclipse with QMK](other_eclipse.md)
* [Using VSCode with QMK](other_vscode.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* Git Best Practices
* [Introduction](newbs_git_best_practices.md)
* [Your Fork](newbs_git_using_your_master_branch.md)
* [Merge Conflicts](newbs_git_resolving_merge_conflicts.md)
* [Fixing Your Branch](newbs_git_resynchronize_a_branch.md)
* Keyboard Building
* [Hand Wiring Guide](hand_wire.md)
* [ISP Flashing Guide](isp_flashing_guide.md)
more wip
2020-02-20 19:57:43 +00:00
More sidebar organization
2020-02-25 17:17:24 +00:00
* Simple Keycodes
* [Full List](keycodes.md)
* [Basic Keycodes](keycodes_basic.md)
Documentation for keymap_extras (#9194)
2020-05-27 00:52:48 +00:00
* [Language-Specific Keycodes](reference_keymap_extras.md)
[Docs] Update layer documentation (#8371) * [Docs] Update layer documentation * Add layer_state_cmp functions * Fix cut/copy/paste issue * Add id tags * Apply noroads corrections * Move Layers section to separate document * Fix ID tag for layers * Use better name for summary/side bar * Fix feature page linkage As well as a small spell error close by * Remove paper analogy for now
2020-03-21 17:17:02 +00:00
* [Modifier Keys](feature_advanced_keycodes.md)
More sidebar organization
2020-02-25 17:17:24 +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
More sidebar organization
2020-02-25 17:17:24 +00:00
* Advanced Keycodes
* [Command](feature_command.md)
* [Dynamic Macros](feature_dynamic_macros.md)
* [Grave Escape](feature_grave_esc.md)
* [Leader Key](feature_leader_key.md)
break feature_advanced_keycodes.md up into multiple files
2020-02-25 21:58:22 +00:00
* [Mod-Tap](mod_tap.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Macros](feature_macros.md)
* [Mouse Keys](feature_mouse_keys.md)
* [Space Cadet Shift](feature_space_cadet.md)
* [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md)
First pass at reorganizing docs
2018-08-11 21:54:27 +00:00
More sidebar organization
2020-02-25 17:17:24 +00:00
* Software Features
overhaul the newbs guide
2020-02-25 18:58:36 +00:00
* [Auto Shift](feature_auto_shift.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Combos](feature_combo.md)
* [Debounce API](feature_debounce_type.md)
* [Key Lock](feature_key_lock.md)
[Docs] Update layer documentation (#8371) * [Docs] Update layer documentation * Add layer_state_cmp functions * Fix cut/copy/paste issue * Add id tags * Apply noroads corrections * Move Layers section to separate document * Fix ID tag for layers * Use better name for summary/side bar * Fix feature page linkage As well as a small spell error close by * Remove paper analogy for now
2020-03-21 17:17:02 +00:00
* [Layers](feature_layers.md)
break feature_advanced_keycodes.md up into multiple files
2020-02-25 21:58:22 +00:00
* [One Shot Keys](one_shot_keys.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Pointing Device](feature_pointing_device.md)
[Documentation] Added raw hid documentation page (#7640) * Added raw hid feature documentation page * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/features.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * added feature_rawhid.md to _summary.md in docs * fixed _summary.md order * Update docs/feature_rawhid.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update feature_rawhid.md Removed the useless bit about finding usage page and usage. * Update feature_rawhid.md * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Update docs/feature_rawhid.md Co-Authored-By: Nick Brassel <nick@tzarc.org> * Remove teensy client, small origanization fixes * Fixed merge conflicts Removed features.md Updated _summary.md with new format and added RAW HID entry under Software Features * Added rawhid feature page Messy is what you get when you don't do things right the first time Co-authored-by: fauxpark <fauxpark@gmail.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-01 13:41:58 +00:00
* [Raw HID](feature_rawhid.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Swap Hands](feature_swap_hands.md)
* [Tap Dance](feature_tap_dance.md)
break feature_advanced_keycodes.md up into multiple files
2020-02-25 21:58:22 +00:00
* [Tap-Hold Configuration](tap_hold.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Terminal](feature_terminal.md)
* [Unicode](feature_unicode.md)
* [Userspace](feature_userspace.md)
Add Word Per Minute calculation feature (#8054) * Add Word Per Minute calculation feature * Fix copyright info * Remove header from quantum.c, setup overloadable keycode inclusion for WPM, update docs * Simplify logic for keycode filtering * Adding link from summary to wpm_feature info * Update docs/feature_wpm.md Typo in function prototype example in docs Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Add WPM transport via i2c Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-03-22 13:06:16 +00:00
* [WPM Calculation](feature_wpm.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* Hardware Features
* Displays
more wip
2020-02-20 19:57:43 +00:00
* [HD44780 LCD Controller](feature_hd44780.md)
* [OLED Driver](feature_oled_driver.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* Lighting
* [Backlight](feature_backlight.md)
* [LED Matrix](feature_led_matrix.md)
more wip
2020-02-20 19:57:43 +00:00
* [RGB Lighting](feature_rgblight.md)
* [RGB Matrix](feature_rgb_matrix.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Audio](feature_audio.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)
Hid joystick interface (#4226) * add support for hid gamepad interface add documentation for HID joystick Add joystick_task to read analog axes values even when no key is pressed or release. update doc Update docs/feature_joystick.md Manage pin setup and read to maintain matrix scan after analog read * Incorporates patches and changes to HID reporting There are some patches provided by @a-chol incorporated on this commit, and also some changes I made to the HID Report structure. The most interesting is the one dealing with number of buttons: Linux doesn't seem to care, but Windows requires the HID structure to be byte aligned (that's in the spec). So if one declares 8/16/32... buttons they should not have any issues, but this is what happens when you have 9 buttons: ``` bits |0|1|2|3|4|5|6|7| |*|*|*|*|*|*|*|*| axis 0 (report size 8) |*|*|*|*|*|*|*|*| ... |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| |*|*|*|*|*|*|*|*| axis 6 |*|*|*|*|*|*|*|*| first 8 buttons (report size 1) |*| | | | | | | | last of 9 buttons, not aligned ``` So for that I added a conditonal that will add a number of reports with size 1 to make sure it aligns to the next multiple of 8. Those reports send dummy inputs that don't do anything aside from aligning the data. Tested on Linux, Windows 10 and Street Fighter (where the joystick is recognized as direct-input) * Add save and restore of each pin used in reading joystick (AVR). Allow output pin to be JS_VIRTUAL_AXIS if the axis is connected to Vcc instead of an output pin from the MCU. Fix joystick report id Fix broken v-usb hid joystick interface. Make it more resilient to unusual settings (none multiple of eight button count, 0 buttons or 0 axes) Correct adc reading for multiple axes. Piecewise range conversion for uncentered raw value range. Input, output and ground pin configuration per axis. Documentation fixes * Fix port addressing for joystick analog read * The other required set of changes As per the PR, the changes still holding it up. Add onekey for testing. Fix ARM builds. Fix device descriptor when either axes or buttons is zero. Add compile-time check for at least one axis or button. Move definition to try to fix conflict. PR review comments. qmk cformat * avoid float functions to compute range mapping for axis adc reading * Remove V-USB support for now. Updated docs accordingly. * Update tmk_core/protocol/lufa/lufa.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Add support for joystick adc reading for stm32 MCUs. Fix joystick hid report sending for chibios * Fix HID joystick report sending for ChibiOS. Add one analog axis to the onekey:joystick keymap. Fix pin state save and restore during joystick analog read for STM32 MCUs. * Update tmk_core/protocol/chibios/usb_main.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/lufa/lufa.c Co-Authored-By: Ryan <fauxpark@gmail.com> * Add missing mcuconf.h and halconf.h to onekey:joystick keymap. Add suggested fixes from PR. * Switch saveState and restoreState signature to use pin_t type. onekey:joystick : add a second axis, virtual and programmatically animated. * Update docs/feature_joystick.md Co-Authored-By: Ryan <fauxpark@gmail.com> * Update docs/feature_joystick.md Co-Authored-By: Ryan <fauxpark@gmail.com> * Add PR corrections * Remove halconf.h and mcuconf.h from onekey keymaps * Change ADC_PIN to A0 Co-authored-by: achol <allecooll@hotmail.com> Co-authored-by: José Júnior <jose.junior@gmail.com> Co-authored-by: a-chol <achol@notamail.com> Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-07-25 12:01:15 +00:00
* [Joystick](feature_joystick.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [Proton C Conversion](proton_c_conversion.md)
* [PS/2 Mouse](feature_ps2_mouse.md)
* [Split Keyboard](feature_split_keyboard.md)
* [Stenography](feature_stenography.md)
* [Thermal Printer](feature_thermal_printer.md)
* [Velocikey](feature_velocikey.md)
update the summary
2017-07-03 19:30:26 +00:00
more wip
2020-02-20 19:57:43 +00:00
* Developing QMK
Add PR checklist document. (#9913) * Add PR checklist document. * Update docs/pr_checklist.md Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Reword the lower/raise/adjust suggestion somewhat for clarity. * Add suggestion from @Didel for coding conventions. Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-08-06 20:16:14 +00:00
* [PR Checklist](pr_checklist.md)
Add API documentation
2020-02-24 06:37:25 +00:00
* Breaking Changes
* [Overview](breaking_changes.md)
* [My Pull Request Was Flagged](breaking_changes_instructions.md)
* History
Add last breaking changes log to sidebar (#10680) Co-authored-by: Ryan <fauxpark@gmail.com>
2020-10-18 04:46:47 +00:00
* [2020 Aug 29](ChangeLog/20200829.md)
2020 May 30 Breaking Changes Update (#9215) * Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"
2020-05-30 20:14:59 +00:00
* [2020 May 30](ChangeLog/20200530.md)
link the 2020 Feb 29 Breaking Changes changelog from the summary
2020-03-05 23:52:30 +00:00
* [2020 Feb 29](ChangeLog/20200229.md)
Add API documentation
2020-02-24 06:37:25 +00:00
* [2019 Aug 30](ChangeLog/20190830.md)
more wip
2020-02-20 19:57:43 +00:00
* C Development
More sidebar organization
2020-02-25 17:17:24 +00:00
* [ARM Debugging Guide](arm_debugging.md)
more wip
2020-02-20 19:57:43 +00:00
* [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)
spi_master for AVR (#8299) * Change _delay_ms/us() to wait_ms/us() * Switch to platform-agnostic GPIO macros * Add AVR spi_master and migrate Adafruit BLE code * Set verbose back to false * Add clock divisor, bit order and SPI mode configuration for init * Add start and stop functions * Move configuration of mode, endianness and speed to `spi_start()` * Some breaks here would be good * Default Adafruit BLE clock divisor to 4 (2MHz on the Feather 32U4) * Remove mode and divisor enums * Add some docs * No hr at EOF * Add links in sidebar
2020-04-08 01:04:31 +00:00
* [SPI Driver](spi_driver.md)
more wip
2020-02-20 19:57:43 +00:00
* [WS2812 Driver](ws2812_driver.md)
* [EEPROM Driver](eeprom_driver.md)
ARM split - Add uart half duplex transport support (#7987) * ARM split - Add uart half duplex transport support * Fix for f103 * initial full duplex pass * partially remove full duplex * Correct speeds within driver docs Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-05-21 17:00:21 +00:00
* ['serial' Driver](serial_driver.md)
more wip
2020-02-20 19:57:43 +00:00
* [GPIO Controls](internals_gpio_control.md)
* [Keyboard Guidelines](hardware_keyboard_guidelines.md)
* Python Development
* [Coding Conventions](coding_conventions_python.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* [QMK CLI Development](cli_development.md)
more wip
2020-02-20 19:57:43 +00:00
Add API documentation
2020-02-24 06:37:25 +00:00
* Configurator Development
* QMK API
* [Development Environment](api_development_environment.md)
* [Architecture Overview](api_development_overview.md)
Add support for hardware and board initialisation overrides. (#8330) * Add support for hardware and board initialisation overrides. * qmk cformat. * Add some documentation. * Docs clarity. * Make early_hardware_init_pre a no-op for now, until migrations occur. * Doco update * Make distinction between keyboard and ChibiOS board in docs * Doc anchors. * Update tmk_core/protocol/chibios/main.c Co-Authored-By: Joel Challis <git@zvecr.com> * Rework bootloader entry to be off by default, allow opting-in. Co-authored-by: Joel Challis <git@zvecr.com>
2020-04-12 23:39:38 +00:00
* Hardware Platform Development
* Arm/ChibiOS
Add documentation for selecting an Arm MCU (#9046) * Initial doco write-up. * Update docs/platformdev_selecting_arm_mcu.md Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: Ryan <fauxpark@gmail.com>
2020-06-10 22:32:58 +00:00
* [Selecting an MCU](platformdev_selecting_arm_mcu.md)
Add support for hardware and board initialisation overrides. (#8330) * Add support for hardware and board initialisation overrides. * qmk cformat. * Add some documentation. * Docs clarity. * Make early_hardware_init_pre a no-op for now, until migrations occur. * Doco update * Make distinction between keyboard and ChibiOS board in docs * Doc anchors. * Update tmk_core/protocol/chibios/main.c Co-Authored-By: Joel Challis <git@zvecr.com> * Rework bootloader entry to be off by default, allow opting-in. Co-authored-by: Joel Challis <git@zvecr.com>
2020-04-12 23:39:38 +00:00
* [Early initialization](platformdev_chibios_earlyinit.md)
More sidebar organization
2020-02-25 17:17:24 +00:00
* QMK Reference
* [Contributing to QMK](contributing.md)
* [Translating the QMK Docs](translating.md)
* [Config Options](config_options.md)
* [Make Documentation](getting_started_make_guide.md)
* [Documentation Best Practices](documentation_best_practices.md)
* [Documentation Templates](documentation_templates.md)
* [Community Layouts](feature_layouts.md)
* [Unit Testing](unit_testing.md)
* [Useful Functions](ref_functions.md)
* [info.json Format](reference_info_json.md)
more wip
2020-02-20 19:57:43 +00:00
* For a Deeper Understanding
* [How Keyboards Work](how_keyboards_work.md)
split Hand Wire Preamble to a separate doc
2020-02-26 22:02:03 +00:00
* [How a Matrix Works](how_a_matrix_works.md)
more wip
2020-02-20 19:57:43 +00:00
* [Understanding QMK](understanding_qmk.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
more wip
2020-02-20 19:57:43 +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 a new issue Copy permalink