summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Rework I2C driver docs (#11658)Ryan2021-02-082-106/+222
|
* [Docs] Update isp_flashing_guide.md (#11777)moritz-john2021-02-071-0/+10
| | | Added wiring for USBasp and changed the order of the documentation accordingly
* Improve Pointing Device report sending (#11064)Drashna Jaelre2021-02-031-0/+4
| | | | | | | | | | | | | | | | | * Improve Pointing Device report sending * Hide old report behind preprocessors too * put host_mouse_send() in curly brackets * Remove POINTING_DEVICE_ALWAYS_SEND_REPORT functionality * Fix typo * fix function ref in docs Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com> Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* [Docs] Japanese translation of internals_*.md (#10316)umi2021-02-016-0/+633
| | | | | | | * add git checkout internals_related.md translation * update based on comment * unify the end of sentence
* [Docs] Use HTTPS for images and links where possible (#11695)Ryan2021-01-3096-218/+216
|
* Update feature_debounce_type.md of Japanese document. (#10596)shela2021-01-301-25/+125
| | | | | | | | | | | | | | | | | | | | | | | | | * Update Japanese document. * fix table format. * fix heading * Update translation * Apply suggestions from code review Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Update docs/ja/feature_debounce_type.md Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> * Bump up comment tag Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
* Add rgblight_reload_from_eeprom() (#11411)Joshua Diamond2021-01-281-0/+1
| | | | | * Add rgblight_reset_from_eeprom() * reset->reload
* [Docs] add qmk setup home parameter (#11451)glanchow2021-01-281-0/+2
|
* fix(feature_ps2_mouse): fix Scroll Button example (#11669)David H. Bronke2021-01-241-1/+1
| | | Corrected macro in Scroll Button example so it compiles.
* Update docs/getting_started_make_guide.md (#11373)Takeshi ISHII2021-01-242-4/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * update docs/getting_started_make_guide.md Added description of some targets, including those added with #11338. * Added description of options added by #11324. * update docs/getting_started_make_guide.md * Added description of target. * Update docs/getting_started_make_guide.md Co-authored-by: Drashna Jaelre <drashna@live.com> * Update docs/getting_started_make_guide.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/getting_started_make_guide.md Co-authored-by: Drashna Jaelre <drashna@live.com> * add ':id=linux-udev-rules' to docs/faq_build.md Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* Fix typos and reword some sentences in FAQs (#11546)smiley2021-01-233-29/+27
| | | | | | | | | * Fix minor typo in "General FAQ" "want to do brand it with QMK" -> "want to brand it with QMK" * Reword some of "Debugging FAQ" & "Miscellaneous FAQ". Mostly grammatical wording of some parts and missing capitalization
* Small tweaks to docs to make them more user friendly (#11518)Joel Challis2021-01-2012-275/+269
| | | | | | | | | | | | | | | * first pass * firmware firmware? * Split out debug + testing docs * tidy up duplicate css * Add extra info to debug example Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
* Add stm32-dfu and apm32-dfu to bootloader.mk (#11019)Ryan2021-01-201-115/+124
| | | | | | | | | * Add stm32-dfu and apm32-dfu to bootloader.mk * Update flashing docs * Update comment * Further wordsmithing
* Improve the Lighting Layers example in RGB Lighting docs (#11454)Joshua Diamond2021-01-191-9/+18
| | | | | * Improve the keymap layer state -> lighting layers example * A few more improvements
* Improve the compile and flash subcommands (#11334)Zach White2021-01-161-4/+4
| | | | | | | | | | | | | | | | | | | * add support for --clean to compile and flash * compile standalone JSON keymaps without polluting the tree * Add support for passing environment vars to make * make flake8 happy * document changes to qmk compile and flash * add -e support to json export compiling * Fix python 3.6 * honor $MAKE * add support for parallel builds
* Add BGR byte order for WS2812 drivers (#11562)kb-elmo2021-01-161-4/+5
| | | | | | | | | | | | | * add byte order bgr for ws2812 * update docs for driver change * Update ws2812_driver.md * Update docs/ws2812_driver.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* allow customizing decrease delay of rgb heatmap (#11322)André Silva2021-01-141-0/+13
| | | | | | | | | | | | | | | | | | | | | * allow customizing decrease delay of rgb heatmap * rename rgb typing heatmap decrease delay variable * address review comments * nix-shell: add clang-tools required for formatting the C code * heatmap: use real timer to track decrement rate * heatmap: fix ifndef var name typo * heatmap: add docs * Update docs/feature_rgb_matrix.md Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
* Fix documentation so UCIS example compiles. (#11541)Erovia2021-01-141-1/+1
|
* [Docs] Update feature_rgblight.md (#11363)Nick Blyumberg2021-01-101-0/+2
| | | | | | | | | | | * Update feature_rgblight.md The note is meant to let people know that this is specific to RGB Backlight and does not work with RGB Matrix based implementations. * Update docs/feature_rgblight.md Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
* Fix documentation of `lsusb` behaviour (#10903)L. K. Post2021-01-101-1/+1
|
* Correct descriptions of rgblight functions (#11429)Joshua Diamond2021-01-091-8/+8
|
* Fix AUR package name (#11416)Toban Wiebe2021-01-091-2/+2
| | | On Arch, `qmk` is now in the official repos, whereas only `qmk-git` is in AUR.
* Suggest 'QMK MSYS' as the default windows platform (#11321)Joel Challis2021-01-081-0/+15
| | | | | * Suggest 'QMK MSYS' as the default windows platform * Review comments
* [Docs] Japanese translation of feature_rawhid.md (#10858)umi2021-01-061-0/+74
| | | | | | | | | * add feature_rawhid.md translation * update files based on comments * update files based on comments * update files based on comments
* [Docs] Japanese translation of feature_led_indicators.md (#10960)umi2021-01-063-103/+123
| | | | | | | * add feature_led_indicators.md translation * update related document * add link on _summary
* [Docs] Fix typo in hand_wire.md (#11297)Michael Overman2021-01-011-1/+1
|
* Fix typo in hand wiring guide (#11388)s-maurice2021-01-011-1/+1
| | | ridid -> rigid
* Zadig docs: add APM32 device name (#11356)Ryan2020-12-301-1/+1
|
* Add Arch / Manjaro section for Linux setup instructions (#10509)Reibl János Dániel2020-12-301-1/+9
|
* Added mac variant of portuguese keymap extras (#11260)André Cruz2020-12-292-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Added mac variant of portuguese keymap This keymap is very similar to the existing portuguese keymap, but some symbols are moved around. Apply suggestions from code review Corrected whitespace and implemented some suggested changes. Co-authored-by: Ryan <fauxpark@gmail.com> Converted some spaces to nbsp Added sendstring ISO version * Apply suggestions from code review Added suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Replaced space with nbsp * Corrected 2 chars in ascii_to_shift_lut { and } require shift Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keycode docs (#11343)Ryan2020-12-302-82/+82
|
* Update Zadig docs with list of bootloader device names and IDs (#11337)Ryan2020-12-291-8/+37
|
* Typo fix: Useful function -> Useful Functions (#11342)Chas2020-12-301-1/+1
| | | Thanks!
* Ensure single newline at EOF for core files (#11310)Ryan2020-12-2815-16/+7
|
* Simplify the visual flow of the getting started page (#11316)Joel Challis2020-12-274-14/+114
| | | | | | | | | | | | | | | | | | | * Add tabs to getting started page * Review comments Co-authored-by: Ryan <fauxpark@gmail.com> * Align with current theme * Update docs/newbs_getting_started.md Co-authored-by: Ryan <fauxpark@gmail.com> * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* docs: add Gentoo to newbs_getting_started.md (#11241)Boris Faure2020-12-231-0/+1
|
* [Docs] Update links in main README.md (#11284)Nick Blyumberg2020-12-221-1/+1
| | | | | | It looks like features.md was deprecated and content was split into other files. This results in a broken link on the main page which, if removed, would have no impact to the remainder of the documentation. This would also: resolve #9239 resolve #10293 resolve #10447
* [Docs] Add clarification on use of custom RGB Matrix effect (#11176)Daniele De Vincenti2020-12-221-0/+6
| | | | | | | | | | | | | | | | | * Update feature_rgb_matrix.md Added more clarification on how to use a newly created rgb effect as it was unclear that the prefix 'RGB_MATRIX_CUSTOM_' had to be added. Also included an example consistent with the documentation example. * Update docs/feature_rgb_matrix.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update docs/feature_rgb_matrix.md Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
* Updated Raw HID docs to clarify packet/report length (#11211)Kishor Prins2020-12-231-1/+1
| | | Co-authored-by: Ryan <fauxpark@gmail.com>
* Updated usage of qmk c2json (#11148)precondition2020-12-181-1/+1
|
* CLI-ify rgblight_breathing_table_calc.c (#11174)Ryan2020-12-161-0/+10
| | | | Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com> Co-authored-by: Zach White <skullydazed@drpepper.org>
* Add i2c 24LC64 eeprom (#11200)Xelus222020-12-141-0/+1
| | | | | | | | | | | * add 24LC64 eeprom * docs update * Update docs/eeprom_driver.md Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Joel Challis <git@zvecr.com>
* Normalise include statements in core code (#11153)Ryan2020-12-1112-12/+32
| | | | | * Normalise include statements in core code * Missed one
* add definition WS2812_BYTE_ORDER to fix RGB LED issues (#10184)Josh Hinnebusch2020-12-061-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | * add define for WS2812B-2020 to fix RGB issues * update driver doc * add WS2812_BYTE_ORDER definition to correct RGB byte issues * add definition variable thing * update per PR request * update per PR reqs * update per PR request * inital changes * move defines to color.h and add rgbw incase * Update docs/ws2812_driver.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: hineybush <hineybushkeyboards@gmail.com> Co-authored-by: Xelus22 <preyas22@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* 2020 November 28 Breaking Changes Update (#11053)James Young2020-11-2818-58/+385
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Branch point for 2020 November 28 Breaking Change * Remove matrix_col_t to allow MATRIX_ROWS > 32 (#10183) * Add support for soft serial to ATmega32U2 (#10204) * Change MIDI velocity implementation to allow direct control of velocity value (#9940) * Add ability to build a subset of all keyboards based on platform. * Actually use eeprom_driver_init(). * Make bootloader_jump weak for ChibiOS. (#10417) * Joystick 16-bit support (#10439) * Per-encoder resolutions (#10259) * Share button state from mousekey to pointing_device (#10179) * Add hotfix for chibios keyboards not wake (#10088) * Add advanced/efficient RGB Matrix Indicators (#8564) * Naming change. * Support for STM32 GPIOF,G,H,I,J,K (#10206) * Add milc as a dependency and remove the installed milc (#10563) * ChibiOS upgrade: early init conversions (#10214) * ChibiOS upgrade: configuration file migrator (#9952) * Haptic and solenoid cleanup (#9700) * XD75 cleanup (#10524) * OLED display update interval support (#10388) * Add definition based on currently-selected serial driver. (#10716) * New feature: Retro Tapping per key (#10622) * Allow for modification of output RGB values when using rgblight/rgb_matrix. (#10638) * Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. (#10530) * Rescale both ChibiOS and AVR backlighting. * Reduce Helix keyboard build variation (#8669) * Minor change to behavior allowing display updates to continue between task ticks (#10750) * Some GPIO manipulations in matrix.c change to atomic. (#10491) * qmk cformat (#10767) * [Keyboard] Update the Speedo firmware for v3.0 (#10657) * Maartenwut/Maarten namechange to evyd13/Evy (#10274) * [quantum] combine repeated lines of code (#10837) * Add step sequencer feature (#9703) * aeboards/ext65 refactor (#10820) * Refactor xelus/dawn60 for Rev2 later (#10584) * add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk (#10824) * [Core] Added `add_oneshot_mods` & `del_oneshot_mods` (#10549) * update chibios os usb for the otg driver (#8893) * Remove HD44780 References, Part 4 (#10735) * [Keyboard] Add Valor FRL TKL (+refactor) (#10512) * Fix cursor position bug in oled_write_raw functions (#10800) * Fixup version.h writing when using SKIP_VERSION=yes (#10972) * Allow for certain code in the codebase assuming length of string. (#10974) * Add AT90USB support for serial.c (#10706) * Auto shift: support repeats and early registration (#9826) * Rename ledmatrix.h to match .c file (#7949) * Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER (#10231) * Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER (#10840) * Merge point for 2020 Nov 28 Breaking Change
* [Docs] Add VBUS hack for teensys (#10986)Drashna Jaelre2020-11-271-0/+20
|
* Refactor qmk_install.sh (#10681)Ryan2020-11-261-3/+6
|
* Update one_shot_keys.md (#10917)j-zero2020-11-181-1/+1
| | | MOD_RSFT doesn't work. See: https://github.com/qmk/qmk_firmware/issues/10901
* Recommend use of LED Indicator config (#10895)Joel Challis2020-11-161-0/+1
| | | | | | | | | | | * Recommend use of LED Indicator config * Recommend use of LED Indicator config - update link * Update quantum/template/ps2avrgb/config.h Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
* CI: Add docs build and deploy workflow (#7448)Joel Challis2020-11-101-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add docs build and deploy workflow * Remove old travis docs workflow * update to cli command * Tidy up for review * formatting * Update to pass style checks * Update lib/python/qmk/cli/docs.py Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Review comments - build->generate, use of verbose * Add docs * Update to match recent actions * Run within base_container * Convert cli to generate-docs * Convert cli to generate-docs - restore old file * Convert cli to generate-docs * Update docs Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-28 11:20:36 +0000