summaryrefslogtreecommitdiffstats
path: root/docs/_summary.md
Commit message (Collapse)AuthorAgeFilesLines
* Expose zh-cn docs, delete bad zh docs, add docs for adding translations (#6855)Jack Humbert2019-10-011-0/+1
| | | | | | | | | | | | | | * expose zh-cn docs, delete bad zh docs, add docs for adding translations * Update docs/translating.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/translating.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * update for python 3
* Configuration system for CLI (#6708)skullydazed2019-09-221-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Rework how bin/qmk handles subcommands * qmk config wip * Code to show all configs * Fully working `qmk config` command * Mark some CLI arguments so they don't pollute the config file * Fleshed out config support, nicer subcommand support * sync with installable cli * pyformat * Add a test for subcommand_modules * Documentation for the `qmk config` command * split config_token on space so qmk config is more predictable * Rework how subcommands are imported * Document `arg_only` * Document deleting from CLI * Document how multiple operations work * Add cli config to the doc index * Add tests for the cli commands * Make running the tests more reliable * Be more selective about building all default keymaps * Update new-keymap to fit the new subcommand style * Add documentation about writing CLI scripts * Document new-keyboard * Update docs/cli_configuration.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Address yan's comments. * Apply suggestions from code review suggestions from @noahfrederick Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Apply suggestions from code review Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Remove pip3 from the test runner
* Add Dip Switch as a core feature (#6140)Drashna Jaelre2019-09-031-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add Dip Switches as a core feature * Add documentation for Dip Switch feature * Update Preonic Rev3 to use new feature and remove custom matrix * Apply suggestions from code review Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Remove custom matrix line completely Rather than just disabling it Co-Authored-By: fauxpark <fauxpark@gmail.com> * DIP changes Co-Authored-By: fauxpark <fauxpark@gmail.com> * Use better check for DIP Switch configuration * Add to show features * Add bitmask callback for dip switch * Fix OLKB Boards dip switch config * Update docs to include bitmask example * Fix comments/documentation Co-Authored-By: fauxpark <fauxpark@gmail.com> * Fix issues with docs and use example from @tuzonghua * Fix wording Co-Authored-By: fauxpark <fauxpark@gmail.com> * Fix example to use proper formatting Bad, BAAAAAAD drashna!!! * Handle dip switch initialization better
* Merge point for 2019 Aug 30 Breaking ChangeskullY2019-08-301-0/+3
|
* Add Zadig 101 to docs (#6585)fauxpark2019-08-231-0/+1
| | | | | | | | | | | | | | | | | | * 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
* [Docs] Add dedicated page for Split Keyboard information (#5802)Drashna Jaelre2019-07-151-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * [Docs] Add dedicated page for Split Keyboard information * Apply suggestions from code review Co-Authored-By: drashna <drashna@live.com> * Fix Typos Co-Authored-By: drashna <drashna@live.com> * Fix some formatting issues * Add Additional RGB info * Fix Bulletted formatting * Apply suggestions from code review Co-Authored-By: drashna <drashna@live.com> * Fix line wrapping * Additional fixes and expansion * Reword warning/note Co-Authored-By: drashna <drashna@live.com> * add i2c/serial coexistance info * i2c markdown * Change i2c wiring text Co-Authored-By: drashna <drashna@live.com>
* QMK CLI and JSON keymap support (#6176)skullydazed2019-07-151-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Additional link fixesDrashna Jaelre2019-05-221-2/+2
| | | | Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Fix linksDrashna Jaelre2019-05-221-2/+2
| | | Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Add missing links to features page and sidebar sectionDrashna Jaelre2019-05-211-0/+3
|
* Added OLED Driver to the summaryRyan Caltabiano2019-04-301-0/+1
|
* Simple extended space cadet (#5277)XScorpion22019-04-291-2/+1
| | | | | | | | * Simplifying and Extending Space Cadet to work on Ctrl and Alt keys * PR Review feedback * Reverting back to keycodes
* [Docs] Smallish overhaul of the docs (#5281)Drashna Jaelre2019-03-181-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* [Docs] Add VSCode guide to docs (#5124)Drashna Jaelre2019-03-151-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Add LED Matrix to Features list for easy reference (#5280)Drashna Jaelre2019-03-031-0/+1
|
* Velocikey: Match RGB animation speed to typing speed (#3754)Chris Lewis2019-02-211-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Address comments in #4832. Move info.json reference to its own file.skullY2019-02-081-0/+1
|
* Adds Proton C Conversion (#4661)Jack Humbert2019-01-101-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | * 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
* Add support for PR and Issue templates to QMK_firmware GitHub (#4494)Drashna Jaelre2018-12-071-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Re-order feature list in sidebar (#4555)Drashna Jaelre2018-12-051-1/+1
| | | 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.
* 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
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-26 11:21:33 +0000