Commit Graph

750 Commits

Author SHA1 Message Date
Joel Challis
1ea0cac998
ARM - ws2812 bitbang (#7173)
* Initial ARM bitbang ws2812 driver

* Unify chibios platform to run rgblight_task

* Remove 'avr only' comments from ws2812 docs

* Remove 'avr only' comments from ws2812 docs

* Unify chibios platform to run rgblight_task - review comments

* Remove debug flags from keymap

* Add comments from review

* Add defines for STM32L0XX

* Attempt to get arm ws2812 working on multiple gcc versions
2019-11-07 13:10:29 +00:00
fauxpark
dfb78d2a08 New and improved lock LED callbacks (#7215)
* New and improved lock LED callbacks

* Include stdbool

* Update documentation

* Use full function signatures and add keyboard-level example
2019-11-06 00:42:16 +00:00
Drashna Jaelre
542cb0a8ce [Core] Convert Dynamic Macro to a Core Feature (#5948)
* Convert Dynamic Macro to a Core Feature

This imports the code from Dynamic Macro into the core code, and handles it, as such.

This deprecates the old method but does not remove it, for legacy support. This way, no existing user files need to be touched.

Additionally, this reorganizes the documentation to better reflect the changes.

Also, it adds user hooks to the feature so users can customize the existing functionality.

Based heavily on and closes #2976

* Apply suggestions from code review

Co-Authored-By: fauxpark <fauxpark@gmail.com>
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>

* Cleanup based on feedback

* Add short-form keycodes and document them

- add short-form keycodes to quantum/quantum_keycodes.h
- document the new aliases in docs/feature_dynamic_macros.md

* Add Dynamic Macros section and keycodes to docs/keycodes.md

* Make anti-nesting optional

* Add documentation for DYNAMIC_MACRO_NO_NESTING option

* Fix Merge artifacts

* Fix formatting typo in docs

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Remove DYNAMIC_MACRO_RANGE as it's not needed

* Fix includes and layer var type
2019-11-04 22:59:13 -08:00
Drashna Jaelre
29630e6e49 [Core] Add short form LTO_ENABLE (#7259)
For drashna's sanity's sake
2019-11-04 15:35:47 -08:00
Gregory Gubarev
a510e5212b [Docs] Create RU ver getting_started_getting_help (#7227)
* 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>
2019-11-04 13:44:49 -08:00
Thomas Baart
be6562a223 Adds raw write functions to the OLED driver (#7237)
* 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
2019-11-03 14:34:47 -08:00
Drashna Jaelre
e9c44e396d
Smallish overhaul of Auto-Shift feature (#6067)
* 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
2019-11-03 09:52:01 -08:00
Xavier Hahn
bed98091aa French translation - FAQ section (#6995)
* 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>
2019-11-03 08:02:44 -08:00
Joel Challis
1249da4e8e
Use task driven PWM for CTPC until ARM can provide automatic configuration (#6928)
* Use task driven PWM for CTPC until ARM can provide automatic configuration

* Update CTPC docs to cover backlight
2019-11-02 21:21:00 +00:00
Joel Challis
4531cc874e
Initial migration of software PWM backlight (#6709)
* 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
2019-11-02 21:20:03 +00:00
umi
ff8d436946 correct description (#7240) 2019-11-02 13:11:36 +00:00
michizhou
f4c8057a1c [Docs] Add Spanish translation for hardware documentation (#7161)
* 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>
2019-10-31 12:39:50 -07:00
José Ignacio Amelivia Santiago
bc7f1dd296 [Docs] Spanish translation (#7068)
* 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>
2019-10-31 12:36:33 -07:00
Guy Khmelnitsky
742e83e102 [Docs] Add he-IL (Hebrew) Translation (#7001)
* 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
2019-10-31 02:47:07 -07:00
lf
6a75d10979 [Docs] Fix dunder names being accidentally bolded (#7217)
* 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 21:56:59 -07:00
Rico Sta. Cruz
dfdd9e821b [Docs] Update getting_started_vagrant.md (#7203) 2019-10-30 11:53:48 -07:00
Steve Purcell
606813b72d Remove obsolete note about media keys in MacOS (#6631)
* 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-30 10:39:38 +11:00
Joel Challis
64b7cfe735 Refactor ps2avrgb i2c ws2812 to core (#7183)
* 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-29 15:53:11 -07:00
Spaceman
908aede957 Update feature_bluetooth.md (#7193)
* 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-30 09:43:01 +11:00
Wermeille Bastien
cb3b5563e4 [Docs] Fix some misspells in French documentation (#7171)
* Fix some spelling mistakes

* Fix some misspell in french documentation

* Small misspell fix in French in ChangeLog
2019-10-29 15:42:19 -07:00
Dominic Fleckner
f164016566 [Docs] Translated "CLI" documentation to German (#7178)
* 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 13:33:09 -07:00
Drashna Jaelre
0e6f78547e [Docs] Update flashing information to include :flash target (#6999)
* 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-29 13:15:03 -07:00
St. John Johnson
e0e26957d4 Fix the CLI docs (#6979)
- Sort the commands alphabetically
- Add missing `json_keymap`
- Correct underscore to dash
2019-10-29 01:24:36 +00:00
Nikita Titov
4fef3b23e4 [Docs] started Russian translation of Newbs Guide (partial) (#6967)
* 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-28 16:22:58 -07:00
Adam Perlman
1971f22285 Update split i2c docs for example of when pull-ups are required (#7143) 2019-10-28 18:10:25 +00:00
Yadunand Prem
d5316e9714 Update URL for 60-keyboard.hwdb (#7185) 2019-10-28 02:41:22 +00:00
fauxpark
40de65eac4 Backslash-escape pipe character in keycode lists (#7157) 2019-10-26 06:10:03 +01:00
Gouty
19f73483d8 [Docs] Fixed internal links on Handwire page (#7154)
Some of the links were not playing nice on docs.qmk.fm, I think this fixes it.
2019-10-25 18:16:17 -07:00
Gouty
3fd919c536 [Docs] Update hand wire guide (#7044)
* 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-25 11:48:59 -07:00
Erovia
a5a31a5fc0 MILC: Use dashes instead of underscores for subcommands
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-23 22:46:30 -07:00
Max Rumpf
f87908228a Remove apostrophe from various abbreviations' plural forms (#7050)
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-22 13:47:43 +01:00
kuchosauronad0
80ded60cad Add a short explanation to Zadig the troubleshooting section (#7110)
* 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-22 14:05:33 +11:00
Amber Holly
b23f6011c3 Remove build option firmware size impacts (#6947)
* 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 18:14:49 -07:00
Drashna Jaelre
22cc56bc97
[Docs] Fix incorrect spacing on Coding Conventions page (#7058) 2019-10-18 16:59:03 -07:00
Drashna Jaelre
feb116c4f3 [Docs] Replace Switch Hitter link with Wayback Machine link (#7009)
* [Docs] Replace Switch Hitter link with Wayback Machine link

* Add QMK Configurator link as well

To appease yan
2019-10-15 23:21:05 +01:00
makenova
6560dffc05 update one shot keys link (#7020) 2019-10-14 01:26:03 +01:00
Joel Challis
76378d74f5 ARM split - detect USB to select master/slave (#6424)
* 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-11 23:25:43 -04:00
Xavier Hahn
da3ff89fac [Docs] French translation - Breaking Changes section (#6966)
* 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-09 15:45:41 -07:00
Ethan Durrant
8da25dd6e3 [Docs] removed unneeded line of code in Tap Dance documentation (#6981) 2019-10-08 22:01:56 -07:00
Max Rumpf
1c07d4e7ef [Docs] Clean up docs/newbs_flashing.md (#6973)
* [Docs] Clean up docs/newbs_flashing.md

See #6930

* Fix typo
2019-10-08 21:55:44 -07:00
Xavier Hahn
0ea4e86175 [Docs] French translation of QMK Basics (#6925)
* 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 13:27:45 -07:00
fauxpark
2707652c98 [Docs] CLI command to serve docs locally (#6956)
* 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 11:06:26 -07:00
Xavier Hahn
e7d95701bf [Docs] French translation of Complete Newbs Guide (#6901)
* 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-08 10:45:34 -07:00
kuchosauronad0
49fdd386b2 [Docs] Clean up docs/newbs_building_firmware.md (#6930)
* 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 20:08:05 -07:00
Ethan Durrant
e2ec5790b7 [Docs] updated and cleaned up documentation for Tap Dance (#6949) 2019-10-07 19:28:48 -07:00
Drashna Jaelre
403c139b34 [Docs] Add AVR and ARM examples to GPIO Commands (#6942)
* [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-07 19:08:14 -07:00
Max Rumpf
5bb3fe7a35 Remove unanswered/unnecessary FAQ item
As discussed in #6957, closes #6957
2019-10-07 15:43:42 -07:00
fauxpark
3e22af92ee [Docs] Add an important note about modifying user code (#6959)
* 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 14:50:10 -07:00
Dan McClain
f04e58dad6 [CLI] Add qmk list_keyboards (#6927)
`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-07 11:32:30 -07:00
Erdem Efe Erol
d0ef139749 [Docs] Typo fix for feature_hd44780.md (#6917)
* Typo fix

Fixed a typo.

* Update feature_hd44780.md

* Update feature_hd44780.md
2019-10-06 16:39:23 -07:00