* Rename UC_OSX (and related constants) to UC_MAC
* Update UNICODE_SONG_OSX references to UNICODE_SONG_MAC
* Update UC_M_OS references to UC_M_MA
* Add UC_OSX alias for backwards compatibility
* Add deprecation warning for UC_OSX to Unicode docs
* Add UC_M_OS alias for backwards compatibility
* Update newly found UC_M_OS and UNICODE_SONG_OSX references
* Add legacy UNICODE_MODE_OSX alias, revert changes to user keymaps
* Add legacy UNICODE_SONG_OSX alias, revert changes to user keymaps
* Replace removed sounds in Unicode song doc examples
* added the description of the reading order of the rules.mk files.
* Update docs/hardware_keyboard_guidelines.md
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update docs/hardware_keyboard_guidelines.md
Co-Authored-By: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* [Docs] Update RGB Matrix docs with function refs
* Fix up code samples
* suggestions by noroadsleft
* Fix small typo
Co-authored-by: James Young <xxiinophobia@yahoo.com>
* Improve process_record system
Code based on @colinta's
* Rename and better handle functions
* Fix incorrect function call to process_record_user
* Add documentation for post_process_record
* Add both get_event_keycode and get_record_keycode functions
And add some comments about these functions
* Update code format
* Cleanup merge artifacts
* 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>
* Add support for Bootmagic lite when using SPLIT_HAND_PIN
* Deduplicate bootmagic_lite logic from within via
* Revert location of defaults so that user overrides still work for now
* Tidy up code slightly
* [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
* Update switch to array to allow custom values
* Add adc keymap
* update docs to reflect alignment of default 10 bit
* start conversion to USE_ADCVn
* samplerate is hella wrong...stub out for now
* basic f1 and f4 functionality
* Tidy up current changes
* Restore old pinToMux function
* Add back sample rate for supported platforms
* F0 compile fixes
* wordsmithery
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Remove reference to avr only function
Co-authored-by: Ryan <fauxpark@gmail.com>
* fix CLI section links in the Summary
* fix heading in Pointing Device doc
* fix headings in PS/2 Mouse Support doc
* add explicit section ids to I2C Master Driver doc
* reformat GPIO Controls table
Much like the I2C Master Driver doc, I found this a bit less than ideal to read. (The table was actually wider than the space available for it.)
Reformatted so each GPIO function is an H3 heading, followed by a paragraph and a table of each architecture's old-style function.
* migrate changes from I2C Master Driver doc to Japanese translation
* add explicit anchors to I2C Master Driver docs
* fix code block language markers
The language markers are case-sensitive; using the wrong case means the syntax highlighting doesn't work.
Good: ```c
Bad: ```C
* restore Japanese I2C Master Driver doc to current master
Can't update the internal tracking references accurately until the changes to the English doc are committed to master.
* add explicit anchors to edited files
* change ChibiOS/ARM to ARM/ChibiOS
Because ARM/ATSAM is also a thing that exists.
* fix code block language markers again
Used the wrong markers in a few spots. Also these are apparently always supposed to be lowercase.
* add section anchors to cli.md
* restore table formatting on GPIO Control doc
* remove changes to _summary.md
* 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>
* Rearrange the custom CSS a bit.
* fix css name
* add missing quote
* Fix up dark mode rendering. (#8392)
* Fix up dark mode rendering.
* Update index.html
* Fix up code blocks
* Fix code in page toc
* Update docs/qmk_custom_dark.css
Co-Authored-By: Ryan <fauxpark@gmail.com>
Co-authored-by: skullY <skullydazed@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
* Add support for STM32L0/L1 onboard EEPROM.
* Update docs/eeprom_driver.md
Co-Authored-By: Joel Challis <git@zvecr.com>
Co-authored-by: Joel Challis <git@zvecr.com>
* New feature: RGBLIGHT_LAYERS
This feature allows users to define multiple independent layers of lighting
that can be toggled on and off individually, making it easy to use your
RGB lighting to indicate things like active keyboard layer & modifier state.
* Demonstrate built in functions for layer state checking
Also link the video in the docs.
* Follow existing pattern for setting rgblight_status flags
* Eliminate rgblight_is_static_mode since it's not needed
Just check to see if the timer is enabled directly.
* Add buffer based single line pan, arbitrary byte write to buffer
* Change dirty mask to inverse of OLED_BLOCK_TYPE for future proofing larger buffer sizes
* Updating docs to include new functions
* Updating to clarify scroll vs pan
- minor typo on intro paragraph (the -> them)
- remove note about :check-size target (`make` task now does this automatically)
- heading level for Caterina commands section
- typo regarding Halfkay (come -> comes)
* [Docs] Update ISP Flashing guide
* Apply suggestions from code review
AKA why you shouldn't write docs at 2am
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
* Update workding for planck-qmk-dfu
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* complete translation.
* Update docs/ja/feature_tap_dance.md
Update the file based on the suggestions.
* Update docs/ja/feature_tap_dance.md
Update the file based on the suggestions.
* Apply suggestions from code review
Update the file based on the suggestions.
* Apply suggestions from code review
Update the file based on the suggestions (Part 2).
* Apply suggestions from code review
Update the file based on the suggestions (Part 3).
* Apply suggestions from code review
Update the file based on the suggestions (Part 3).
* Apply suggestions from code review
Update the file based on the suggestions (Part 4).
* Apply suggestions from code review
Update the file based on the suggestions (Part 5).
ご提案いただいた修正案は全て確認できました。
続いて、コメント行の調整、「打つ・叩く」の変更、その他の修正を行います。
* fixed typo.
* Update the file based on the suggestions (Part 6).
* Update the file based on the suggestions (Part 7).
* Fixed sentence.
* Update docs/ja/feature_tap_dance.md
Update the file based on the suggestions (Part 8).
* Update the file based on the suggestions (Part 9).
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
* Add link to "Useful functions" in macro docs
Help people find additional features they can activate within a macro
* Update docs/feature_macros.md
Co-Authored-By: Drashna Jaelre <drashna@live.com>
Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
* add detail-guide part
* some updates for easy reading
* some updates for easy reading
* some updates for easy reading
* some updates for easy reading
* some updates for easy reading
* some updates for easy reading
* some updates for easy reading
* some updates for easy reading
* update file based on comment
* update file based on comment
* update file based on comment
* update git command in header
* update files based on comments, and update git command in header
* update file based on comment
* update file based on comment
* update file based on comment
* update file based on comment
* update file based on comment
* update file based on comment
* update file based on comment
* update file based on comment
Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Fix out of bound OLED font access
The default font is 1344 bytes, or a total of 224 glyphs (each 6-bytes wide).
OLED_FONT_END defaults to 224, which if used will then index off the end of
the font array. So either the documentation or code is wrong.
Instead of figuring out the rewording of the documentation, just change
the OLED_FONT_END default value to 223, to match the documentation and code.
* Add static assert to check array size
Build bomb if the font array size doesn't match to the defines.
* update zh-cn translate
Timestamp was added at the end of the document, it can help me manage version easier.
* fix _summary.md to utf-8
* fix _summary.md with vscode
- 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.
* Define default HSV and speed for RGB matrix.
* Documentation for configuration values RGB_MATRIX_STARTUP_HUE, RGB_MATRIX_STARTUP_SAT and RGB_MATRIX_STARTUP_VAL.
* Document RGB_MATRIX_STARTUP_SPD.
* Preserve the ordering.
* Implement IGNORE_MOD_TAP_INTERRUPT_PER_KEY
- Add configurable option IGNORE_MOD_TAP_INTERRUPT_PER_KEY
- Add function get_ignore_mod_tap_interrupt iff the option is enabled
Unless IGNORE_MOD_TAP_INTERRUPT_PER_KEY is defined, this patch does not affect the resulting binary.
* Add documentation for IGNORE_MOD_TAP_INTERRUPT_PER_KEY
* Left-right gradient.
* Update the comment to match the new functionality.
* CPP does integer division so this round is not necessary.
* The x-range is actually 224, update comment and use bit-shifting again.
* Update docs with gradient left-right effect and associated "DISABLE" option.
* add faq part
* add faq part
* add faq part
* add faq part
* add faq part
* update for link
* update for a punctuation
* update files based on comments
* restore removed git diff header
* correct pathname on git diff header
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
* update file based on comment
* update file based on comment
* update file based on comment
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: satt99 <39004890+satt99@users.noreply.github.com>
* add basic part
* update cli
* update cli
* correct links to ja document
* update files based on comments
* update for a postpositional particle
* update for a punctuation
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* fix instructions for oneshot layer handling on key release
* use ONESHOT_OTHER_KEY_PRESSED instead of ONESHOT_PRESSED
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* 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
* Update getting_started_make_guide.md
clarifying that NO_PRINT and USER_PRINT should not be used at the same time.
* Update docs/getting_started_make_guide.md
Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
* 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. 😢
* 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.
* for initial commit
* for initial commit
* for initial commit
* Update led_update_kb example (#7451)
* Update led_update_kb example
* Update comment to explain pin behavior
* wordsmith
* wordsmithing 2
* Remove CR when computing BOOTLOADER_SIZE. (#7453)
* Set up language fallback for docs, and update translation guidelines (#7403)
* 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
* [Keyboard] Added Cans12er keyboard (#7455)
* added cans12er keyboard
* updated readme
Updated the readme to conform with the provided template from the qmk_firmware githubpage
* Update keyboards/cans12er/README.md
Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
* Changed configuration
Changed the configuration based on the Change Request from PR #7455 made by github user noroadsleft
* [Keyboard] Update ATmega32A readme files to match template (#7462)
* Update atmega32a readme files to match template
* Update atmega32a readme files to match template - fixes
* Apply suggestions from code review
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
* update files based on comments
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
* Add shift-to-invert to remaining directional RGB_* keycode pairs
RGB_MODE_FORWARD / RGB_MODE_REVERSE invert their functions when shift is held.
This change adds the same capabilities to the remaining directional RGB_*
keycode pairs. This improves consistency and provides full RGB control in a
keymap containing only one keycode from each pair.
* remove redundant variable
* fix typo
* Fix more typos
Flyspell is on now I swear!
* Install bootloadHid on macos
* Install bootloadHid on windows
* Highlight bootloadHID is now installed in docs
* Update udev rules for bootloadHID
* Install bootloadHid on some distros
* fix caterina udev filename
* 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
* f
* Allow overriding of all functions in wonderland.c
- needed for custom LED functions in keymap.c
* Example of layer indication via LEDs
optimize
* Use newer led_update_kb and led_update_user hooks
- these allow overriding without use of __attribute((weak))__
* Update led documentation a bit
- clarify some of the wording around how to use led_update_user
* Update led_update_user example
* Update audio example to be complete
* trailing spaces smh
* spaces
* spaces
* smh
* Less code is good
* Update docs/custom_quantum_functions.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/custom_quantum_functions.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/custom_quantum_functions.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/custom_quantum_functions.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/custom_quantum_functions.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update docs/custom_quantum_functions.md
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Update japanese translation of newbs.md and related documents.
* document link id change
* add `ja/` in each link
`[xxx](yyy.md)` --> `[xxx](ja/yyy.md)`
* copy docs/ja/_summary.md from umi-umi's #7248 and fix it
* Initial commit
* Fix links so that they point to the german translation
* minor changes to the wording of some sentences
* correctly capitalize second person pronouns
* Fix links so that they point to the german translation
* minor changes to the wording of some sentences
* correctly capitalize second person pronouns
* Translate newbs_learn_more_resources.md
* Clear up some phrases
* Add newbs_building_firmware.md, fix spelling
* Add newbs_building_firmware.md, fix spelling
* Update docs/de/_summary.md
Danke
* Update docs/de/README.md
* Update docs/de/_summary.md
Ich wollte es kuerzer halten damit die Navigationsleiste nicht zu breit wird, aber das ist halt die deutsche Sprache :)
* Update docs/de/newbs.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs.md
* Update docs/de/newbs_learn_more_resources.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs.md
* Update docs/de/newbs.md
* Update docs/de/newbs.md
* Update docs/de/README.md
* Update docs/de/README.md
* Update docs/de/README.md
* Update docs/de/README.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_learn_more_resources.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_learn_more_resources.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_learn_more_resources.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_getting_started.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Update docs/de/newbs_building_firmware.md
* Apply suggestions from code review
* Add translation of newbs_flashing.md
* Apply suggestions from code review
Danke
* Add translation of Zadig-guide
* Translate newbs_testing_debugging.md to german
Co-Authored-By: Max Rumpf <max.rumpf1998@gmail.com>
Co-Authored-By: geisterfurz007 <geisterfurz007@users.noreply.github.com>
A new CLI subcommand was added, flash, which behaves very similar to the already present compile CLI comamnd, but with the added ability to target a bootloader. The command is used like so: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename].
A -kb <keyboard> and -km <keymap> is expected, or a configurator export JSON filename. A bootloader can be specified using -bl <target>, and if left unspecified, the target is assumed to be :flash. -bl can be used to list the available bootloaders.
If -km <keymap> is provided, but no -kb <keyboard>, then a message is printed suggesting the user to run qmk list_keyboards.
* Error out when Solenid pin is not defined
Instead of defaulting to a (literally) random pin, error out instead. Because this pin may be used, or because that pin may not be exposed, or may not exist.
* Remove 'SOLENOID_ACTIVE' setting since it's not used
* Update documentation
* Add initial pass at KLE convert
* Add cli log on convert
* Move kle2xy, add absolute filepath arg support
* Add overwrite flag, and context sensitive conversion
* Update docs/cli.md
* Fix converter.py typo
* Add convert unit test
* Rename to kle2qmk
* Rename subcommand
* Rename subcommand to kle2json
* Change tests to cover rename
* Rename in __init__.py
* Update CLI docs with new subcommand name
* Fix from suggestions in PR #6898
* Help with cases of case sensitivity
* Update cli.md
* Use angle brackets to indicate required option
* Make the output text more accurate
* Fix unicode in comments
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Remove separate RGBW implementation for a unified function
* Set White to 0 in RGBW LEDs
This is just to get this working, later, proper brightness can be handled elsewhere.
* Use us instead of nanoseconds(?) since it renders correctly on web
* Remove RGBW function from arm/ws2812.h
* Remove RGBW function from arm/ws2812.c
* Formatting changes
* Add doc info
* 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
* 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
* 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
* 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
* 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>
* 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
* 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>
* 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
* 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
* 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>
* 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>
* 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>
* 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>
* 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
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.
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 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>
* 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>
* 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>
* 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
* 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] 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>
* Add an important note about modifying user code
* Update docs/contributing.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
`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
* 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
* 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
* 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 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>
* 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
* 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
* Update atreus to current code conventions - add multi revision instead of defines
* Remove config.h duplication from user keymaps
* Add breaking change log
* Add missing pragma once
* Branch point for 2019 Aug 30 Breaking Change
* LUFA USB descriptor cleanup (#4871)
* Fix indentation
* Fix braces
* Expand descriptor headers
* Align descriptor elements
* Nicer formatting
* Tidy up preprocessor statements
* Remove VERSION_BCD redefine - LUFA_VERSION_INTEGER is currently 0x170418
* Tidy up comments
* Tweak ordering of HID report elements (no functional changes)
* We don't need all of these newlines
* Move default USB_MAX_POWER_CONSUMPTION closer to where it makes sense
* Ask nicely
* Add some more comments
* Change indentation back to 4 spaces
* Add changelog entry
* Language Keymap extras backport from ZSA fork (#6198)
* Swedish extra keymap refactor
* Fix swedish $ sign definition (#81)
* Fix br abnt2 keymap compilation error
* Add PR changelog doc
* Update PR6198.md
* Enforce clang-format (#6293)
* Enforce clang-format on commit for core files
* forgot about tests
* Migrate ACTION_LAYER_MOMENTARYs to MO() (#5176)
* Migrate ACTION_LAYER_MOMENTARYs to MO()
* Add changelog entry
* Update docs/ChangeLog/20190830/PR5176.md
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Migrate ACTION_BACKLIGHT_* to BL_*
* Add changelog
* Update docs/ChangeLog/20190830/PR6299.md
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
* Fix indentation
* Fix braces
* Expand descriptor headers
* Align descriptor elements
* Nicer formatting
* Tidy up preprocessor statements
* Remove VERSION_BCD redefine - LUFA_VERSION_INTEGER is currently 0x170418
* Tidy up comments
* Tweak ordering of HID report elements (no functional changes)
* We don't need all of these newlines
* Move default USB_MAX_POWER_CONSUMPTION closer to where it makes sense
* Ask nicely
* Add some more comments
* Change indentation back to 4 spaces
* Add changelog entry
* 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
* Update how_keyboards_work.md
bridged the gap between scancodes and keycodes, the doc didn't make the distinction and was ambiguous.
* Update docs/how_keyboards_work.md
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* Update docs/how_keyboards_work.md
fix typo
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Additional changes for Layer State typedef compatibility
* Replace biton32 with get_highest_layer in docs
* Change additional layer structure code
* Fix uGFX reference issue
* Remove dynamic_keymap check
* Where did all these extra spaces come from
Co-Authored-By: fauxpark <fauxpark@gmail.com>
* Add MAGIC_SWAP_CONTROL_LGUI and MAGIC_UNSWAP_CONTROL_LGUI keycodes
Key codes to swap and unswap the control and windows/cmd keys
* Fix issues with pull request #6110
Renamed swap/unswap lctl and lgui key codes, added key codes to swap/unswap rctl and rgui, and moved new bool inside keycode_config.h struct to the end
* Move new keycodes to the end of the enum (#6110)
* add cases for swapped control and OS keys to mod_config (#6110)
* Add new keycodes to feature_bootmagic.md (#6110)
* Add R+L swap codes to keep in parity with AG_* codes
* Extend Magic range check to include new magic codes
* Update audio docs
* Combine 2 byte ranges into 1 word for EECONFG
Fix names for Keymap config EEPROM
* Update docs/feature_bootmagic.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Update docs/feature_bootmagic.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Update docs/feature_bootmagic.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Update docs/feature_bootmagic.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Remove superfluous JTAG disable code
* 32A has differently named register
* Accidentally some operators
* 32A also has different JTAG pins
* Wrap disable_jtag() in an ifndef
* Document this new define
* Rename the define, it conflicts with a LUFA thing
Also, move the ifndef wrapping to the call in keyboard_setup()
* Improve backlight PWM pin support
* I accidentally an equals sign
* Another typo
* Order by pin number
* Throw an error if backlight pin is C4 or C5 on 16/32U4
* Use else for clarity
* Minor alignment adjustments
* Add Sections and MO(layer)/TG(layer) Example
Major changes:
1. Added sub-section headings to the portion before the examples.
2. Added a new Example 6, that allows MO(layer) and TG(layer) functionality to be embedded within tap dance functions.
Minor Changes:
1. Edited some text to better fit with new sub-headings.
* Update feature_tap_dance.md
* Update feature_tap_dance.md
* Update IS_COMMAND definition in templates to use MOD_MASK_SHIFT
* Update IS_COMMAND in docs
* Update IS_COMMAND default definition in tmk_core
* Update table in Command docs based on suggestion
Co-Authored-By: fauxpark <fauxpark@gmail.com>
