summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2019-10-30[Docs] Fix dunder names being accidentally bolded (#7217)lf
* Fix dunder names being accidentally bolded * Update docs/coding_conventions_python.md Co-Author: fauxpark <fauxpark@gmail.com> * Change all the "names to avoid" to use backticks
2019-10-30[Docs] Update getting_started_vagrant.md (#7203)Rico Sta. Cruz
2019-10-30Remove obsolete note about media keys in MacOS (#6631)Steve Purcell
* 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>
2019-10-29 Refactor ps2avrgb i2c ws2812 to core (#7183)Joel Challis
* 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>
2019-10-30Update feature_bluetooth.md (#7193)Spaceman
* 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>
2019-10-29[Docs] Fix some misspells in French documentation (#7171)Wermeille Bastien
* Fix some spelling mistakes * Fix some misspell in french documentation * Small misspell fix in French in ChangeLog
2019-10-29[Docs] Translated "CLI" documentation to German (#7178)Dominic Fleckner
* 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>
2019-10-29[Docs] Update flashing information to include :flash target (#6999)Drashna Jaelre
* 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>
2019-10-29Fix the CLI docs (#6979)St. John Johnson
- Sort the commands alphabetically - Add missing `json_keymap` - Correct underscore to dash
2019-10-28[Docs] started Russian translation of Newbs Guide (partial) (#6967)Nikita Titov
* 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>
2019-10-28Update split i2c docs for example of when pull-ups are required (#7143)Adam Perlman
2019-10-28Update URL for `60-keyboard.hwdb` (#7185)Yadunand Prem
2019-10-26Backslash-escape pipe character in keycode lists (#7157)fauxpark
2019-10-25[Docs] Fixed internal links on Handwire page (#7154)Gouty
Some of the links were not playing nice on docs.qmk.fm, I think this fixes it.
2019-10-25[Docs] Update hand wire guide (#7044)Gouty
* 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
2019-10-23MILC: Use dashes instead of underscores for subcommandsErovia
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.
2019-10-22Remove apostrophe from various abbreviations' plural forms (#7050)Max Rumpf
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.
2019-10-22Add a short explanation to Zadig the troubleshooting section (#7110)kuchosauronad0
* 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>
2019-10-18Remove build option firmware size impacts (#6947)Amber Holly
* 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>
2019-10-18[Docs] Fix incorrect spacing on Coding Conventions page (#7058)Drashna Jaelre
2019-10-15[Docs] Replace Switch Hitter link with Wayback Machine link (#7009)Drashna Jaelre
* [Docs] Replace Switch Hitter link with Wayback Machine link * Add QMK Configurator link as well To appease yan
2019-10-14update one shot keys link (#7020)makenova
2019-10-11ARM split - detect USB to select master/slave (#6424)Joel Challis
* 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
2019-10-09[Docs] French translation - Breaking Changes section (#6966)Xavier Hahn
* 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>
2019-10-08[Docs] removed unneeded line of code in Tap Dance documentation (#6981)Ethan Durrant
2019-10-08[Docs] Clean up docs/newbs_flashing.md (#6973)Max Rumpf
* [Docs] Clean up docs/newbs_flashing.md See #6930 * Fix typo
2019-10-08[Docs] French translation of QMK Basics (#6925)Xavier Hahn
* 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>
2019-10-08[Docs] CLI command to serve docs locally (#6956)fauxpark
* 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
2019-10-08[Docs] French translation of Complete Newbs Guide (#6901)Xavier Hahn
* 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
2019-10-07[Docs] Clean up docs/newbs_building_firmware.md (#6930)kuchosauronad0
* Clean up the blocks in the second section so that macOS & Windows are in the same block with the command * As suggested by fauxpark
2019-10-07[Docs] updated and cleaned up documentation for Tap Dance (#6949)Ethan Durrant
2019-10-07[Docs] Add AVR and ARM examples to GPIO Commands (#6942)Drashna Jaelre
* [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>
2019-10-07Remove unanswered/unnecessary FAQ itemMax Rumpf
As discussed in #6957, closes #6957
2019-10-07[Docs] Add an important note about modifying user code (#6959)fauxpark
* Add an important note about modifying user code * Update docs/contributing.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
2019-10-07[CLI] Add `qmk list_keyboards` (#6927)Dan McClain
`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
2019-10-06[Docs] Typo fix for feature_hd44780.md (#6917)Erdem Efe Erol
* Typo fix Fixed a typo. * Update feature_hd44780.md * Update feature_hd44780.md
2019-10-06[Docs] Removed dead link (#6922)Erdem Efe Erol
Removed an old link and fixed a typo
2019-10-05ARM - Initial backlight support (#6487)Joel Challis
* 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
2019-10-02Fixed typos in documentation (#6871)Erik Doffagne
* 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>
2019-10-01Expose zh-cn docs, delete bad zh docs, add docs for adding translations (#6855)Jack Humbert
* 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
2019-09-27ARM split - Add support for dfu-util EE_HANDS flashing (#6543)Joel Challis
* 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
2019-09-24ARM split - Add bootmagic/magic keycodes for setting handedness (#6545)Joel Challis
* Add docs on bootmagic/magic keycodes for setting handedness * Clang format fixes * Maintain backwards compatibility * Maintain backwards compatibility
2019-09-22Configuration system for CLI (#6708)skullydazed
* 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
2019-09-21Update the breaking changes process so we always have a future branch (#6785)skullydazed
2019-09-21Generalize Tap Dance Layer functions (#6629)Drashna Jaelre
* 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
2019-09-20Add support for 328P hardware backlight on B1/B2 (#6776)fauxpark
2019-09-20[Keyboard] Add Discipad, Update Zadig doc for USBaspLoader (#6771)coseyfannitutti
* 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
2019-09-20Cleanup rules.mk for 32A and 328P keyboards (#6767)fauxpark
2019-09-19Add reset instructions for boards that use Command to the Zadig driver ↵Konstantin Đorđević
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>
2019-09-19DRV2605L Continuous Haptic Feedback Support (#6461)MechMerlin
* 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
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-09 19:04:29 +0000