summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* [Core] Add short form LTO_ENABLE (#7259)Drashna Jaelre2019-11-041-1/+2
| | | For drashna's sanity's sake
* [Docs] Create RU ver getting_started_getting_help (#7227)Gregory Gubarev2019-11-041-0/+15
| | | | | | | | | | | * Create RU ver getting_started_getting_help * uodate RU ver of getting_started_getting_help * Update docs/ru-ru/getting_started_getting_help.md Co-Authored-By: nabokovas <bbkv@bk.ru> Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
* Adds raw write functions to the OLED driver (#7237)Thomas Baart2019-11-031-0/+6
| | | | | | * Added oled_write_raw and oled_write_raw_P functions to the OLED driver * Added oled_write_raw method calls to feature_oled_driver.md
* Smallish overhaul of Auto-Shift feature (#6067)Drashna Jaelre2019-11-031-10/+10
| | | | | | | | | | | | | * Fix edge case when using One Shot Layer with Auto Shift, and it not triggering the cleanup * Remove junk code (no longer used) * Replace `(un)register_code` calls with `tap_code` where appropriate * Fixed up Switch check to be more readable (less verbose) * Simplified modifier check (if it comes back non-zero, there are mods) * Add additional function calls for autoshift settings * Made all variables static, since there are function calls to get their status * Fixed up documentation * Re-add special characters that were missed * formatting pass
* French translation - FAQ section (#6995)Xavier Hahn2019-11-0325-23/+735
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Translated faq.md and added all other files (copy from English) * Translated driver_installation_zadig.md in French * Translated faq_build.md in French * Translated faq_debug in French * Translateed faq_general.md in French * Translated first part of faq_keymap.md * Renamed docs/fr-FR folder to docs/fr-fr * Finished translation of faq_keymap.md * Update faq_build.md * Review (#3) * Review * Update docs/fr-fr/faq_keymap.md * Update docs/fr-fr/faq_debug.md * Fix some PR comments Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch> Co-Authored-By: Wermeille Bastien <bastien.wermeille@gmail.com>
* Use task driven PWM for CTPC until ARM can provide automatic configuration ↵Joel Challis2019-11-021-0/+10
| | | | | | | | (#6928) * Use task driven PWM for CTPC until ARM can provide automatic configuration * Update CTPC docs to cover backlight
* Initial migration of software PWM backlight (#6709)Joel Challis2019-11-021-44/+87
| | | | | | | | | | | | * Initial migration of software PWM backlight * First pass at backlight driver docs * Correct driver name in docs * Run backlight_task when using BACKLIGHT_PINS * Resolve backlight docs TODOs
* correct description (#7240)umi2019-11-021-1/+1
|
* [Docs] Add Spanish translation for hardware documentation (#7161)michizhou2019-10-314-0/+374
| | | | | | | | | | | | | * Add Spanish translation for hardware documentation * Finished Spanish translations for hardware docs * Resolved errors in Spanish page translations * Corrected misspelled folder name in documentation Co-Authored-By: Karey Higuera <karey.higuera@gmail.com> Co-Authored-By: José Ignacio Amelivia Santiago <ohcan2@gmail.com>
* [Docs] Spanish translation (#7068)José Ignacio Amelivia Santiago2019-10-3113-1/+1102
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * add all translation docs to translating.md * Adding Spanish folder and README.md * Adding Spanish to the langs file * Adding a Spanish summary file * Small corrections on the Spanish README file * Adding Spanish newbs.md * Translate some newbs documentation * Adding the translated newbs getting started file * Adding the building firmware file * Adding a translated building firmware with configurator file * Adding the flashing guide * Adding the newbs_testing_debugging file * Apply suggestions from code review * QMK Configurator -> Configurador QMK Co-Authored-By: Karey Higuera <karey.higuera@gmail.com>
* [Docs] Add he-IL (Hebrew) Translation (#7001)Guy Khmelnitsky2019-10-3114-0/+531
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add he-IL (Hebrew) Translation * Add Hebrew to SUMMARY * Try RTL * Add RTL text * Lowercase folder names * Update lowercase folder in Summary * Adding getting_started_introduction.md * Add Proton C Conversion translation * Add Becoming a QMK Collaborator Translation * Add FAQ translation * Add Hardware translation * Documentation Best Practices translation * Add FAQ General translation * Align docs RTL * Add Becoming a QMK Collaborator Translation * Translate Getting Started - Getting Help * Translate Getting Started With Github * Code sections should be alligned to the left * Code sections should be alligned to the left * Code sections should be alligned to the left * Revert "Code sections should be alligned to the left" This reverts commit d0c46e90c4915ceebe7c5182aca2b75afad25df0. * Add Markdown aligned to the left * Update quantum_keycodes.md * Update proton_c_conversion.md * Translate Newbs Learn More Resourses
* [Docs] Fix dunder names being accidentally bolded (#7217)lf2019-10-301-3/+3
| | | | | | | | | | * 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
* [Docs] Update getting_started_vagrant.md (#7203)Rico Sta. Cruz2019-10-301-2/+2
|
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-26 10:25:06 +0000