aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* Remove obsolete note about media keys in MacOS (#6631)Steve Purcell2019-10-303-12/+5
| | | | | | | | | | | | | | * Remove obsolete note about media keys in MacOS KC_MNXT and KC_MPRV work fine on MacOS, so this note is obsolete. * Document behaviour of MEDIA_FAST_FORWARD/MEDIA_REWIND codes on MacOS * Small typo fix, and make OS-dependent keycode claim less absolute * Update docs/keycodes_basic.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Refactor ps2avrgb i2c ws2812 to core (#7183)Joel Challis2019-10-292-0/+34
| | | | | | | | | | | | | | | | | | | | * 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>
* Update feature_bluetooth.md (#7193)Spaceman2019-10-301-6/+6
| | | | | | | | | | | | | | * Update feature_bluetooth.md * Update feature_bluetooth.md * Update docs/feature_bluetooth.md Co-Authored-By: Joel Challis <git@zvecr.com> * Update docs/feature_bluetooth.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
* [Docs] Fix some misspells in French documentation (#7171)Wermeille Bastien2019-10-2915-60/+60
| | | | | | | | * Fix some spelling mistakes * Fix some misspell in french documentation * Small misspell fix in French in ChangeLog
* [Docs] Translated "CLI" documentation to German (#7178)Dominic Fleckner2019-10-291-0/+169
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Translated "CLI" documentation to German > * Weise den User an, die Umgebungs-Variable `QMK_HOME` zu setzen, um die Firmware-Quelle anders einzustellen als `~/qmk_firmware`. - I wasn't quite sure with this translation, as I didn't understand the context in the original English docs. - The link to the CLI Configuration page is currently not working, due to it being missing in German. * Update docs/de/cli.md - typo * Update docs/de/cli.md - added Installation option into documentation * Update docs/de/cli.md - changed article for CLI * Update docs/de/cli.md Spelling * Update docs/de/cli.md Spelling * Update docs/de/cli.md de-anglicization * Update docs/de/cli.md Spelling * Update docs/de/cli.md Synonym * Update docs/de/cli.md Added Installation option * Cleaned up installation option duplicate Co-Authored-By: kuchosauronad0 <22005492+kuchosauronad0@users.noreply.github.com>
* [Docs] Update flashing information to include :flash target (#6999)Drashna Jaelre2019-10-297-107/+145
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update Newbs Flashing guide For the newbs that want to start flashing * Update flashing docs * Misc flashing * Attempt at flashing in french Lets hope I didn't butcher this too badly with machine transations * Update docs/feature_userspace.md * Apply language suggestions from code review * Apply suggestions from code review * Apply additional fr lang suggestions from code review * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch> Co-Authored-By: Xavier Hahn <xavier.hahn@gmail.com> Co-Authored-By: Vincent LE GOFF <vince.legoff@gmail.com>
* Fix the CLI docs (#6979)St. John Johnson2019-10-291-10/+20
| | | | | - Sort the commands alphabetically - Add missing `json_keymap` - Correct underscore to dash
* [Docs] started Russian translation of Newbs Guide (partial) (#6967)Nikita Titov2019-10-285-0/+326
| | | | | | | | | | | | | * started Russian translation * added translation of some newbs docs * do not translate firmware word in name and transliterate names keeping original ones in brackets * addressed review comments * addressed more review comments Co-Authored-By: nabokovas <bbkv@bk.ru>
* Update split i2c docs for example of when pull-ups are required (#7143)Adam Perlman2019-10-281-1/+1
|
* Update URL for `60-keyboard.hwdb` (#7185)Yadunand Prem2019-10-281-1/+1
|
* Backslash-escape pipe character in keycode lists (#7157)fauxpark2019-10-263-71/+71
|
* [Docs] Fixed internal links on Handwire page (#7154)Gouty2019-10-251-4/+4
| | | Some of the links were not playing nice on docs.qmk.fm, I think this fixes it.
* [Docs] Update hand wire guide (#7044)Gouty2019-10-251-46/+192
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Reorganised Hand Wire Guide Added some images and put the "Matrix" section in a hidden <details> section * Actually adding images this time removed .jpg from .gitignore * Hand wire guide updated Incomplete, but started making the guide more general. Will continue to add images (in imgur as requested) * Removed some more images from gitignore * testing image changes (temporary) * Update hand_wire.md * added techniques table * Tweaking the table * Finished soldering guide * Fixed some links, change image scaling * More of the same * resizing images * updated images * Update hand_wire.md * Resizing images * Update hand_wire.md * Update hand_wire.md * Create ribbon_cable.jpg * Minor updates to links * Updated firmware and flashing guidelines * Updated images to imgur links and re-added images to gitignore * Implemented requested changes. Improved wording * Added handwire helpers info and split KB info * Update hand_wire.md * Removed "the" from "the QMK toolbox" * Fixed handwire helper table and image size * Fixed a heading
* MILC: Use dashes instead of underscores for subcommandsErovia2019-10-231-2/+2
| | | | | | | The subcommand functions' name follows the Python convention of using snake case, but looks odd on the command line. Fix it by converting underscores to dashes, eg.: list_keyboards -> list-keyboards.
* Remove apostrophe from various abbreviations' plural forms (#7050)Max Rumpf2019-10-224-9/+9
| | | | | | While this was historically a valid possibility, nowadays, it reads kinda weird, and the [Oxford Dictionaries Online suggests to avoid it](https://english.stackexchange.com/a/56010). Thus, I removed it everywhere I found it.
* Add a short explanation to Zadig the troubleshooting section (#7110)kuchosauronad02019-10-221-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | * Add a short explanation to the troubleshooting section While translating I noticed that the troubleshooting section could use a little bit more explanation. @Yanfali was so kind to chime in on this on discord and explained that this was ment for people who accidently forget to put their board in bootloader mode, so I added this as a possible common mistake. Also fixed the spelling of Msys2 to MSYS2 and Halfkay to HalfKay as these are the official spellings they use themselves. * Update driver_installation_zadig.md * Update driver_installation_zadig.md English is hard. * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Remove build option firmware size impacts (#6947)Amber Holly2019-10-184-18/+12
| | | | | | | | | | | | | | | | | | | | | | * Update rules.mk template to remove build option size impacts * Add rules.mk cleaning script * Update all rules.mk files to remove build option firmware size impact messages * Remove references to feature filesize in documentation * Revert "Update all rules.mk files to remove build option firmware size impact messages" This reverts commit 7cfe70976bcc223bf47c960b2e6af8596df80a32. * Fix regex in cleanup script and exclude keymaps/ directories * Update quantum/template/avr/rules.mk Fixed missing tabs/spaces. Co-Authored-By: fauxpark <fauxpark@gmail.com>
* [Docs] Fix incorrect spacing on Coding Conventions page (#7058)Drashna Jaelre2019-10-181-7/+7
|
* [Docs] Replace Switch Hitter link with Wayback Machine link (#7009)Drashna Jaelre2019-10-153-3/+6
| | | | | | | | * [Docs] Replace Switch Hitter link with Wayback Machine link * Add QMK Configurator link as well To appease yan
* update one shot keys link (#7020)makenova2019-10-141-1/+1
|
* ARM split - detect USB to select master/slave (#6424)Joel Challis2019-10-112-0/+20
| | | | | | | | | | | | * Initial split refactor to allow usb master detection * Add split USB detect docs * Add SPLIT_USB_DETECT demo mode limitation * fix rebase issues * clang-format
* [Docs] French translation - Breaking Changes section (#6966)Xavier Hahn2019-10-093-3/+162
| | | | | | | | | | | | | * Translated breaking_changes.md in French * Translated ChangeLog/20190830.md to French * Update docs/fr-FR/breaking_changes.md Co-Authored-By: Max Rumpf <max.rumpf1998@gmail.com> * Fix comments from @zekth Co-Authored-By: Vincent LE GOFF <g_n_s@hotmail.fr>
* [Docs] removed unneeded line of code in Tap Dance documentation (#6981)Ethan Durrant2019-10-081-3/+0
|
* [Docs] Clean up docs/newbs_flashing.md (#6973)Max Rumpf2019-10-081-8/+16
| | | | | | | | | * [Docs] Clean up docs/newbs_flashing.md See #6930 * Fix typo
* [Docs] French translation of QMK Basics (#6925)Xavier Hahn2019-10-087-8/+567
| | | | | | | | | | | | | | | | | | | | | | * Adds the files that will be translated * Start translate cli_configuration.md in French * Translated cli.md in French * Translated getting_started_getting_help.md in French * /getting_started_github.md * Translated first part of contributing.md in French * Finish translation of contributing.md * Translated the getting_started_introduction.md in French * Corrected issues from @zekth review Co-Authored-By: Vincent LE GOFF <g_n_s@hotmail.fr>
* [Docs] CLI command to serve docs locally (#6956)fauxpark2019-10-081-0/+10
| | | | | | | | | | | | | | | | * CLI command to serve docs locally * Document it * Default port * Use `with` and subclass `SimpleHTTPRequestHandler` to set working dir * Apply suggestions from code review Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Update docs/cli.md
* [Docs] French translation of Complete Newbs Guide (#6901)Xavier Hahn2019-10-0812-1/+1329
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Translated _summary.md + newbs.md * Translated news_best_practices.md in French * Translated newbs_building_firmware_configurator.md in French * Translated the file newbs_building_firmware.md in French * Translated page newbs_flashing.md in French * Translated the page newbs_getting_started.md in French * Translated the page newbs_learn_more_resources.md in French * Translated the page newbs_testing_debugging.md in French * Change translation of split from 'séparé' to 'scindé' * Adding the lang file for gitbook and some others tranme other translation * Correcting typos after Gimly's review * Some others sections on the summary * Fix first comments from @zekth * Fix some issues from @4sStylZ * Fix other issues from @4sStylZ * Fix weird phrase * Replaced all uses of 'téléverser' by 'flash' * Replaced all planches by board * Fix other PR comments * Fix comment
* [Docs] Clean up docs/newbs_building_firmware.md (#6930)kuchosauronad02019-10-071-5/+5
| | | | | | * Clean up the blocks in the second section so that macOS & Windows are in the same block with the command * As suggested by fauxpark
* [Docs] updated and cleaned up documentation for Tap Dance (#6949)Ethan Durrant2019-10-071-32/+30
|
* [Docs] Add AVR and ARM examples to GPIO Commands (#6942)Drashna Jaelre2019-10-071-11/+10
| | | | | | | | | | | * [Docs] Add AVR and ARM examples to GPIO Commands Add examples for reference for people not as well versed in microcontroller coding, such as myself. * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Remove unanswered/unnecessary FAQ itemMax Rumpf2019-10-071-4/+0
| | | As discussed in #6957, closes #6957
* [Docs] Add an important note about modifying user code (#6959)fauxpark2019-10-071-3/+5
| | | | | | | | * Add an important note about modifying user code * Update docs/contributing.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* [CLI] Add `qmk list_keyboards` (#6927)Dan McClain2019-10-071-0/+10
| | | | | | | | | `list_keyboards` replicates the `make list-keyboards` by globbing for all paths that include `rules.mk` and then removing the paths that include `keymaps`. This basis of this cli command could be reused in the future as a util, but is not done so here since this would be the only place that would use it currently Resolves #6911
* [Docs] Typo fix for feature_hd44780.md (#6917)Erdem Efe Erol2019-10-061-3/+4
| | | | | | | | | | * Typo fix Fixed a typo. * Update feature_hd44780.md * Update feature_hd44780.md
* [Docs] Removed dead link (#6922)Erdem Efe Erol2019-10-061-2/+2
| | | Removed an old link and fixed a typo
* ARM - Initial backlight support (#6487)Joel Challis2019-10-051-13/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Move AVR backlight to own file, add borrowed ARM implementation * Tiny fix for backlight custom logic * Remove duplicate board from rebase * Fix f303 onekey example * clang-format * clang-format * Remove backlight keymap debug * Initial pass of ARM backlight docs * Initial pass of ARM backlight docs - resolve todos * fix rules validation logic * Add f072 warning * Add f072 warning * tidy up breathing in backlight keymap * tidy up breathing in backlight keymap * add missing break to backlight keymap
* Fixed typos in documentation (#6871)Erik Doffagne2019-10-024-11/+11
| | | | | | | | | | | | * Fixed typos in documentation * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/arm_debugging.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Expose zh-cn docs, delete bad zh docs, add docs for adding translations (#6855)Jack Humbert2019-10-018-230/+159
| | | | | | | | | | | | | | * 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
* ARM split - Add support for dfu-util EE_HANDS flashing (#6543)Joel Challis2019-09-274-4/+19
| | | | | | | | | | | | * Initial stab at some fake dfu-util-split-left behaviour * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> * Clang format fixes * Fake eeprom init for both left and right hand
* ARM split - Add bootmagic/magic keycodes for setting handedness (#6545)Joel Challis2019-09-242-28/+36
| | | | | | | | | | * Add docs on bootmagic/magic keycodes for setting handedness * Clang format fixes * Maintain backwards compatibility * Maintain backwards compatibility
* Configuration system for CLI (#6708)skullydazed2019-09-226-54/+408
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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
* Update the breaking changes process so we always have a future branch (#6785)skullydazed2019-09-211-5/+4
|
* Generalize Tap Dance Layer functions (#6629)Drashna Jaelre2019-09-211-1/+3
| | | | | | | | | | | | | | * made tapdance dual_role general * updated original dual_role functionality * added toggling layer example * Fix dual role and add alias * Update docs about new layer tap dances * Fix up based on feedback
* Add support for 328P hardware backlight on B1/B2 (#6776)fauxpark2019-09-201-10/+12
|
* [Keyboard] Add Discipad, Update Zadig doc for USBaspLoader (#6771)coseyfannitutti2019-09-201-1/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add discipad * Update driver_installation_zadig.md * Update keyboards/coseyfannitutti/discipad/info.json Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/coseyfannitutti/discipad/readme.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update rules.mk * Update keyboards/coseyfannitutti/discipad/rules.mk Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keyboards/coseyfannitutti/discipad/discipad.c Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update docs/driver_installation_zadig.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update rules.mk * Update discipad.c * Update driver_installation_zadig.md * Update config.h
* Cleanup rules.mk for 32A and 328P keyboards (#6767)fauxpark2019-09-201-25/+55
|
* Add reset instructions for boards that use Command to the Zadig driver ↵Konstantin Đorđević2019-09-191-4/+4
| | | | | | | | | | | | | | installation guide (#6770) * Add reset instructions for boards that use Command to the Zadig driver installation guide * -> → → * Apply suggestions from code review Replace shorthand keycode names with full names Co-Authored-By: fauxpark <fauxpark@gmail.com>
* DRV2605L Continuous Haptic Feedback Support (#6461)MechMerlin2019-09-191-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | * provide means to turn on RTP mode and set the amplitude * new keycode HPT_CONT to turn RTP off/on * introduce new keycodes HPT_CONI, and HPT_COND for Haptic Continuous Increase and Decrease * support for continuous mode amplitude increase and decrease * code cleanup * update docs to reference new keycodes and functionality * don't touch the keymaps * add function prototypes * add proper guards * cleanup guards * remove extra reserved
* Clarify the backlight_level API doc slightly (#6733)xster2019-09-151-1/+2
| | | | | | * Clarify the backlight_level API doc slightly * review
* Make USB polling rate configurable with a define (#6668)fauxpark2019-09-061-1/+3
|
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-05 15:42:11 +0000