summaryrefslogtreecommitdiffstats
path: root/docs/_summary.md
Commit message (Collapse)AuthorAgeFilesLines
...
* Documentation for keymap_extras (#9194)Ryan2020-05-271-0/+1
|
* ARM split - Add uart half duplex transport support (#7987)Joel Challis2020-05-211-0/+1
| | | | | | | | | | | | | | | * 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>
* Reintegrate previous docker docs (#9084)Joel Challis2020-05-191-1/+3
|
* [Documentation] Added raw hid documentation page (#7640)Ahmed Elshafey2020-05-011-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* Add a syllabus to guide people who are learning QMK (#8816)skullydazed2020-04-191-0/+1
|
* Add support for hardware and board initialisation overrides. (#8330)Nick Brassel2020-04-131-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* spi_master for AVR (#8299)Ryan2020-04-081-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Add Word Per Minute calculation feature (#8054)brickbots2020-03-231-0/+1
| | | | | | | | | | | | | | | | | | | | | * 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>
* [Docs] Update layer documentation (#8371)Drashna Jaelre2020-03-211-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | * [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
* Fix some broken links in the docs (#8394)skullydazed2020-03-151-2/+0
| | | | | | | | | | | | | * fix some broken links * remove duplicate and confusing material from cli.md * Switch brazil to the 2 letter country code * Update docs/_langs.md Co-Authored-By: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* link the 2020 Feb 29 Breaking Changes changelog from the summaryJames Young2020-03-051-0/+1
|
* make sure all our redirects are in orderskullY2020-03-051-1/+1
|
* split Hand Wire Preamble to a separate docJames Young2020-03-051-0/+1
|
* rearrange the sidebar a bitskullY2020-03-051-4/+4
|
* make custom_keycode_names.md a faq entry insteadskullY2020-03-051-1/+0
|
* break feature_advanced_keycodes.md up into multiple filesskullY2020-03-051-2/+5
|
* improve our docsify setupskullY2020-03-051-2/+2
|
* overhaul the newbs guideskullY2020-03-051-4/+7
|
* More sidebar organizationskullY2020-03-051-72/+83
|
* Add API documentationskullY2020-03-051-9/+18
|
* Rework the newbs guide around the qmk cliskullY2020-03-051-2/+3
|
* _summary.md: move Auto Shift page to Software Features categoryJames Young2020-03-051-1/+1
|
* rework the index pageskullY2020-03-051-1/+2
|
* more wipskullY2020-03-051-106/+114
|
* wipskullY2020-03-051-81/+76
|
* change Instructions listing in Docs summaryJames Young2020-01-251-1/+1
|
* add Breaking Change PR Instructions docJames Young2020-01-251-0/+1
|
* Add customisable EEPROM driver selection (#7274)Nick Brassel2020-01-241-0/+1
| | | | | | | | | - uprintf -> dprintf - Fix atsam "vendor" eeprom. - Bump Kinetis K20x to 64 bytes, too. - Rollback Kinetis to 32 bytes as partitioning can only be done once. Add warning about changing the value. - Change RAM-backed "fake" EEPROM implementations to match eeconfig's current usage. - Add 24LC128 by request.
* Add docs for 'CUSTOM_MATRIX = lite' (#7906)Joel Challis2020-01-181-0/+1
| | | | | | | | | | | | | | | | * Add some docs to cover 'CUSTOM_MATRIX = lite' * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> * Add 'SRC += matrix.c' docs * Update docs/custom_matrix.md Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-authored-by: fauxpark <fauxpark@gmail.com>
* Improve support and docs for ADC driver (#7191)fauxpark2019-12-081-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Improve support and docs for ADC driver * Comment ADC channels * Move to Makers and Modders section, and fix usage instructions * Flesh out intro * Superscript 328P note * Fix pin_to_mux LUT * Support USB64/1287 as well * analogReadPin() defaults to 0V mux on invalid pin * Update pinToMux() function documentation * Dot * Accept (some of) the `qmk cformat` changes * Do clang-format properly * More wording tweaks * Link to encoder docs
* [Docs] Restructure of Git Best Practices doc (#7231)James Young2019-12-021-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
* Set up language fallback for docs, and update translation guidelines (#7403)fauxpark2019-11-231-1/+1
| | | | | | | | | | | | | | * 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
* [Doc] Tidy up compatible MCUs docs (#7295)fauxpark2019-11-081-0/+1
| | | | | | | | | | | | * Tidy up compatible MCUs docs * ARM chips should have USB * 32KB soft lower limit applies to ARM as well * NXP is the manufacturer name, not Kinetis * Units
* Refactor ps2avrgb i2c ws2812 to core (#7183)Joel Challis2019-10-291-0/+1
| | | | | | | | | | | | | | | | | | | | * Refactor ps2avrgb i2c ws2812 to core * Refactor jj40 to use ws2812 i2c driver * Refactor ps2avrgb template to use ws2812 i2c driver * Add ws2812 stub files * clang-format and driver config * Add ws2812 driver docs * Fix default config values * Update tmk_core/protocol/vusb/main.c Co-Authored-By: Drashna Jaelre <drashna@live.com>
* 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
| | | | | | |