gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-27 11:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
28,852 Commits 64 Branches 1,650 Tags 1.1 GiB
bootstrap
Commit Graph

43 Commits

Author SHA1 Message Date
Nick Brassel
cb46402a5f
Apply suggestions from code review 
Co-authored-by: Joel Challis <git@zvecr.com>
 2025-05-24 09:34:15 +10:00
Nick Brassel
176aa1f7db
Docs, first pass. 2025-04-22 22:32:02 +10:00
Ryan
78a0adfbb4
[docs] Organize driver & feature docs into subfolders (#23848) 
Co-authored-by: Nick Brassel <nick@tzarc.org>
 2024-06-02 12:42:24 +10:00
Nick Brassel
6ef9717288
Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
Ryan
92a787ca4c
[Docs] Use HTTPS for images and links where possible (#11695) 2021-01-30 22:00:56 +11:00
Takeshi ISHII
944cf6476e
Update docs/getting_started_make_guide.md (#11373) 
* 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>
 2021-01-24 15:15:11 +09:00
Morten Linderud
7d5ba88e6f
50-qmk.rules: Move udev rules from documentation into a file (#10664) 
This makes it overall easier to package for downstream distributions
instead of keeping tabs with inline documentation.

Signed-off-by: Morten Linderud <morten@linderud.pw>
 2020-10-17 20:30:18 +01:00
Erovia
a67b32425b Docs: fix udev rules 
Apparently, udev does not like inline comments.
Rules with them are ignored, oops.
 2020-10-06 17:29:47 -07:00
fauxpark
a0305f5e7e Be more specific about Caterina devices, and add LilyPad PID 2020-09-19 05:40:25 +10:00
fauxpark
c2a0cebf8b Add Pololu VID 2020-09-19 05:21:33 +10:00
fauxpark
07e37c857c Update rules in doctor.py 2020-09-19 05:21:30 +10:00
fauxpark
a21e487fbc Consolidate udev rules into a single file 2020-09-19 05:21:29 +10:00
Erovia
e6bcc232ed
Docs: update ModemManager recommendation (#9328) 
Instead of modifying the service file provided by the distro,
use drop-in functionaly to explicitly specify the policy.
 2020-07-07 19:22:38 +01:00
Pete Johanson
b9a38487f3
[Docs] Update udev rules to use TAG+="uaccess". (#8750) 2020-06-07 09:06:55 +01:00
skullY
fcf150bd82 Streamline the macos install process 2020-05-18 22:46:33 -07:00
Drashna Jaelre
a52e55ec09 [Docs] Update macOS related issues in docs (#7744) 
* [Docs] Update macOS related issues in docs

* Update faq_build.md

* Apply suggestions from code review

Co-Authored-By: fauxpark <fauxpark@gmail.com>

Co-authored-by: fauxpark <fauxpark@gmail.com>
 2019-12-31 14:33:54 +00:00
Joel Challis
071eb2478f Remove mbed files (#7605) 
* Remove mbed files

* Remove mbed files - fix comment

* Remove mbed logic blocks
 2019-12-11 11:36:00 -08:00
fauxpark
770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 2019-12-11 11:33:09 -08:00
fauxpark
698d0dbda8 Use clock_prescale_set() from avr-libc (#7540) 
* Use `clock_prescale_set()` from avr-libc

* Remove outdated FAQ info
 2019-12-11 01:26:40 +00:00
Joel Challis
235da6973d
Install bootloadHid as part of qmk_install (#7463) 
* 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
 2019-11-28 15:29:11 +00:00
fauxpark
fb7c65dc34 Add Zadig 101 to docs (#6585) 
* 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
 2019-08-23 23:38:21 -07:00
Joel Challis
b567785345 [Docs] Add dfu-util and caterina udev examples (#6429) 2019-08-01 09:20:31 -07:00
Drashna Jaelre
001a6c24ae [Docs] Clarify Zadig usage in FAQ Docs (#6360) 
* Rewrite Zadig section to be more clear

* Wordsmithing

Co-Authored-By: MechMerlin <30334081+mechmerlin@users.noreply.github.com>
 2019-07-19 13:23:16 -07:00
Danny Nguyen
4f2f2271cd Change from avr-gcc@7 to @8 for Mac 2019-06-05 17:51:39 -07:00
Rob Rogers
2519de92b5 [Docs] Add udev rule for Input Club bootloaders (#5494) 
* Add udev rule for Input Club bootloaders

* match style with file name above udev rule
 2019-03-27 08:42:03 -07:00
Drashna Jaelre
c534a4c775 [Docs] Smallish overhaul of the docs (#5281) 
* Fix up Common functions doc

* Add to extra commands to flashing doc

* Rearrange and touch up Macros

* Expand Newbs Flashing guide

* Update process_record documentation

* Add git to best practices name in sidebar

* Expand FAQ for build/flashing

* Add deprecated info to functions

* Update docs/feature_macros.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/feature_macros.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/keymap.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/newbs_flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/newbs_flashing.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/custom_quantum_functions.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/faq_build.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/feature_macros.md

Co-Authored-By: drashna <drashna@live.com>

* Update docs/keymap.md

Co-Authored-By: drashna <drashna@live.com>

* Fix up Common functions doc

* Make pre-init example accurate

* Update docs/custom_quantum_functions.md

Co-Authored-By: drashna <drashna@live.com>

* Zadig Driver catchall

* Spelling Depriciated

* Completely remove fn_actions section
 2019-03-18 14:22:02 -07:00
Yan-Fa Li
efef54032b [Docs] Add section about EEPROM on ARM (#5070) 
* [Docs] Add section about EEPROM on ARM

* Add Preonic firmware

* Update docs/faq_build.md

add hyperlink

Co-Authored-By: yanfali <yanfali@gmail.com>
 2019-02-18 08:50:22 -08:00
Robin Hallabro-Kokko
4397b17ca0 faq_build.md: Add section about serial devices on Linux 2019-02-06 14:56:40 -08:00
Michael Kaylan
b1e74aee43 Make sure that avr-gcc@7 gets linked into the path on MacOS. 2018-11-12 12:16:43 -08:00
Colin T.A. Gray
91bfbb6256 Updates docs - planck 6 and macos instructions (#4201) 
* add note about how to install rev6 (dfu-util)

* include instructions on installing dfu-util on macOS
 2018-10-22 11:19:51 -07:00
Drashna Jaelre
ea17e363a6 Add instructions for zadig when bootloader device is unknown 2018-10-20 11:48:10 -04:00
Evan Travers
0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337) 
If you run `brew install avr-gcc`, you get a version that has
compatibility issues with LUFA. I updated the getting started guide for
osx, the qmk_install setup script, and added a section to the FAQ for
folks like me who accidentally updated avr-gcc past 7.
 2018-07-07 17:37:37 -07:00
Drashna Jaelre
07b90db897 Fixes and updates to docs (#2611) 
* Fix advanced keycode headers

* Add caveat for OSM over Remote Desktop

* Hopefully add better anchors to docs

* Add Action code list reference

* Formatting of RGB Underglow doc

* Add brew update issue on macOS

* Revert formatting

* Revert RGB doc formatting

* Make Config Options doc's sections linkable
 2018-03-25 16:44:17 -07:00
Ben Hilburn
8df2ee4ec3 Minor updates to docs (#2406) 
* [docs/] Cleaning up some language to make it more clear.

* [docs/] Adding instructions for installing deps on RH / Fedora.
 2018-02-19 14:09:05 -05:00
fauxpark
bb53635f33 Trim trailing whitespace 2017-12-09 10:46:11 -05:00
fauxpark
7b0356d1d4 Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
Devin J. Pohly
7aaef16266 Fix internal links in docs/ (#2080) 
One link in the summary (Modding your keyboard) referred to a page that
was deleted; the rest have been updated to point to the new names.
 2017-11-30 10:18:01 -08:00
Jason Milkins
78923cb884 Fix code backticks on Frequently Asked Build Questions docs 2017-10-21 09:58:48 -10:00
Jack Humbert
800ec55dfc Make arguments redo, subproject elimination (#1784) 
* redo make args to use colons, better folder structuring system [skip ci]

* don't put spaces after statements - hard lessons in makefile development

* fix-up some other rules.mk

* give travis a chance

* reset KEYMAPS variable

* start converting keyboards to new system

* try making all with travis

* redo make args to use colons, better folder structuring system [skip ci]

* don't put spaces after statements - hard lessons in makefile development

* fix-up some other rules.mk

* give travis a chance

* reset KEYMAPS variable

* start converting keyboards to new system

* try making all with travis

* start to update readmes and keyboards

* look in keyboard directories for board.mk

* update visualizer rules

* fix up some other keyboards/keymaps

* fix arm board ld includes

* fix board rules

* fix up remaining keyboards

* reset layout variable

* reset keyboard_layouts

* fix remainging keymaps/boards

* update readmes, docs

* add note to makefile error

* update readmes

* remove planck keymap warnings

* update references and docs

* test out tarvis build stages

* don't use stages for now

* don't use stages for now
 2017-10-14 11:32:19 -10:00
Roy Wellington Ⅳ
c0a6935fb3 Fix these links, as they appear to be broken (#1595) 
It looks like build_environment_setup.md got renamed to
getting_started_build_tools.md in this commit:

	commit e6c638bed1
	Author: skullY <skullydazed@gmail.com>
	Date:   Sat Aug 5 20:54:34 2017 -0700

		Overhaul the Getting Started section and add a FAQ section

	 docs/{build_environment_setup.md => getting_started_build_tools.md} | 132 ++++++++++++++++++++++++++++++++++++-------------------------------------

This commit adjusts the links to match the new name.
 2017-08-18 00:18:04 -07:00
skullY
9d1a08e38a Doc updates from going through every file 2017-08-16 15:47:20 -04:00
skullY
d8e29b53fe Update a bunch of docs 2017-07-03 01:30:36 -07:00
Jack Humbert
ca01d94005 convert docs to lowercase and underscores 2017-06-10 14:58:24 -04:00