sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,168 Commits 17 Branches 0 Tags 16 MiB
6edd3b1d50
Commit Graph

318 Commits

Author SHA1 Message Date
James Fitzgerald
d7d253b1ea Further documentation improvements 2022-07-14 10:29:25 +00:00
James Fitzgerald
ec1f84f9ea Documentation improvements 2022-07-14 10:29:25 +00:00
James Fitzgerald
0e58bdc343 Improve documentation clarity 2022-07-14 10:29:25 +00:00
James Fitzgerald
9a3524d363 Implement Text Replacement module 2022-07-14 10:29:25 +00:00
nogg3r5
00700e373c Update rgb.md 
The referenced function is above, not below this function.
 2022-07-13 08:08:33 -07:00
Gleb Sabirzyanov
6fe2457d8e Rename encoder resolution to divisor 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
2e515d25b4 Fix typo in docs/encoder.md 
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
a22e9754c1 Add encoder pinout to the docs 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
f83e3361e4 Improve encoder docs 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
946a8a8652 Improve doc example formatting 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
1293863cc0 Add note about divisor and smooth encoders 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
61ef788dc6 Fix different brackets in two places in encoder.md 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
1bc54a10a1 Remove extra newline in encoder.md 
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
17e63a435d Fix typo in encoder docs 
Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
edb5bc336e Add encoder resolution info 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
c4f81e3bd6 Tiny formatting fix 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
e478fed927 Minor wording improvement 2022-07-08 11:03:01 +00:00
Gleb Sabirzyanov
9e71038853 Improve encoder docs wording and formatting 2022-07-08 11:03:01 +00:00
James Fitzgerald
64d9147615 Fix missing commas in example code for Combos 2022-07-05 08:47:15 -07:00
xgpt
9e1d9aa621 Update Getting_Started.md 2022-07-03 08:11:52 +00:00
James Fitzgerald
26b629cc45 Explicitly define CircuitPython 7.0 or higher as the minimum supported version 2022-07-02 09:31:57 -07:00
crazyiop
03d5f7ae10 [split] improve doc 2022-06-30 00:38:20 -07:00
crazyiop
d2eba7b4ef [split] cleanup: remove target_left (unused) 
only split_target_left is used
 2022-06-30 00:38:20 -07:00
James Fitzgerald
b25f325871 Rename randomize to enable_interval_randomization 2022-06-30 06:37:57 +00:00
James Fitzgerald
7886b374b6 Implement suggestions and improve documentation clarity 2022-06-30 06:37:57 +00:00
James Fitzgerald
c77bfc432a Change "presses" to "taps" for clarity and consistency 2022-06-30 06:37:57 +00:00
James Fitzgerald
c5c927acf2 Implement suggested documentation changes 
* Clarify how `wait` and `toggle` work
* Add additional example code
 2022-06-30 06:37:57 +00:00
James Fitzgerald
6033dc91d0 Make toggle functionality start after wait period 2022-06-30 06:37:57 +00:00
James Fitzgerald
b55942731d Add toggle functionality 2022-06-30 06:37:57 +00:00
James Fitzgerald
654127bac7 Minor doc addition 2022-06-30 06:37:57 +00:00
James Fitzgerald
d5dfbf456f Add RapidFire module 2022-06-30 06:37:57 +00:00
nogg3r5
8db4cbbf94 Updated docs to match default states in led.py 2022-06-28 08:14:27 -07:00
nogg3r5
c54f4fea6c Added brightness to example 2022-06-28 08:14:27 -07:00
James Fitzgerald
63d54cd9b5 Fix wrong module name used in oneshot.md 2022-06-24 14:12:17 -07:00
crazyiop
b7de9122c2 [doc:rgb] fix link to neopixel lib 
The link is hardcoded to a commit from 2018-12-21 (version 3.3.5) while
we are currently at 6.3.3.

The rgb makes use of the fact that NeoPixel is a subclass of PixelBuf
but that was not true back then. Hence some people following the link in
the doc get a neopixel library incompatible with kmk.
 2022-06-23 23:21:24 +00:00
nogg3r5
17aac3b901 Fixed missing closing bracket 2022-06-22 14:20:19 +00:00
crazyiop
50b8554757 [doc] change link to a better one 2022-06-11 19:27:15 +00:00
crazyiop
d1f23a668c [doc] add a simple way to make a coord_mapping 2022-06-11 19:27:15 +00:00
James Fitzgerald
b6a782e83c Improve clarity in mouse_keys.md 
Improved consistency and clarity by bringing keycode representation in line with other documentation containing keycodes.
 2022-06-11 09:10:26 -07:00
Björn Bösel
5bf33056bf removed handling of old scroll/pointing toggle 2022-06-09 01:58:07 -07:00
Björn Bösel
f44c1a8c20 update docs for pimoroni 2022-06-09 01:58:07 -07:00
Björn Bösel
a58293600d update docs for pimoroni 2022-06-09 01:58:07 -07:00
Björn Bösel
4b0e459d62 Add layers to pimoroni trackball 2022-06-09 01:58:07 -07:00
chemicalwill
f21fa5edb7 Added KC.MACRO_SLEEP_MS(ms) example 
* provided an example of KC.MACRO_SLEEP_MS(ms) within sequences.md
 2022-06-06 16:12:18 -07:00
chemicalwill
3ee701e986 Point KC.MACRO_SLEEP_MS(ms) to sequeces.md 
* macros.md no longer exists
* moving documentation for KC.MACRO_SLEEP_MS(ms) to sequencs.md
 2022-06-06 16:12:18 -07:00
xs5871
80b44b5c1b update combo docs 2022-06-05 16:32:25 -07:00
Stefan Foulis
8460c5abfe fix typo in code example in easypoint docs 2022-06-05 20:22:31 +00:00
Stefan Foulis
093d0329e6 fix typos in Split docs 2022-06-05 14:29:16 +00:00
Stefan Foulis
b04b740f9a fix typo in Split docs 2022-06-04 10:49:34 -07:00
Kyle Brown
645124dab6 cleanup comments 2022-05-31 23:09:49 -07:00
Cole Smith
b91974bce2 rgb matrix now can work out what side its on using the drive name 2022-05-28 12:05:36 -07:00
Isaac Benitez
4a29530ad5 Correct Split function in example code 2022-05-23 23:15:00 +00:00
Isaac Benitez
1771b76b19 Correct import statements in example code 2022-05-23 23:15:00 +00:00
cole smith
d895da5a6a Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
fb931ab2d3 Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
d95b4344dd Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
dade827c76 Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
72d6fb9304 Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
Cole Smith
eb23ed0020 added peg rgb_ 
matrix code and docs
 2022-05-21 19:36:26 -07:00
chemicalwill
73e17d780a Changed links to relative filepath links 2022-05-20 12:29:37 -07:00
chemicalwill
da0e987b68 Updated directories and added links to keys.py 2022-05-20 12:29:37 -07:00
Steven Wilde
0e051a904b Added Dynamic Sequences to modules.md 2022-05-19 15:10:32 +00:00
Steven Wilde
8d0b835c9c Improved readability and finished renaming 2022-05-19 15:10:32 +00:00
Steven Wilde
a6e5ee1c08 Renamed to Dynamic Sequences 2022-05-19 15:10:32 +00:00
Steven Wilde
55b06bba79 Added dynamic macros module 2022-05-19 15:10:32 +00:00
Cole Smith
664af4d4f2 I missed a few things in the docs 2022-05-12 21:56:01 +00:00
Cole Smith
719cef4945 fixed docs formatting 2022-05-12 21:56:01 +00:00
Cole Smith
6970a6c786 oled data is now a class 2022-05-12 21:56:01 +00:00
Cole Smith
7e760a2917 made changes from klardotsh's review 2022-05-12 21:56:01 +00:00
Cole Smith
86e3b138b2 Required libs in docs 2022-05-12 21:56:01 +00:00
Cole Smith
caab7a4a15 added oleds and docs 2022-05-12 21:56:01 +00:00
John Morrison
c183bebb58 Conform class name case conventions 2022-05-08 20:10:41 +00:00
John Morrison
bea0f6d75b Requested rename 2022-05-08 20:10:41 +00:00
John Morrison
12e7a1b42c Class should be capital, use get rather than exception 2022-05-08 20:10:41 +00:00
John Morrison
73e95bfdde Change to be an extension 2022-05-08 20:10:41 +00:00
John Morrison
9f964aba36 Allow strings in keymap. Replace with keys in keyboard _init cycle. 2022-05-08 20:10:41 +00:00
xs5871
256c0f1c55 update tapdance docs 2022-05-06 20:29:26 -07:00
Syed Hussaini
609e275c03 doc updates based on the comments and refactoring 2022-05-02 21:02:40 +00:00
Syed Hussaini
660b751c87 review updates and renamed to Sticky Mod 2022-05-02 21:02:40 +00:00
Syed Hussaini
a0efbb92d5 docs update 2022-05-02 21:02:40 +00:00
Syed Hussaini
bce7959f66 modholdandtap implementation 2022-05-02 21:02:40 +00:00
xs5871
bd87b278b8 Update scanners.md 
fix `KeysScanner` example
 2022-04-25 16:03:18 -07:00
John Morrison
4419f13f1c PR requested changes 2022-04-25 17:50:26 +00:00
John Morrison
8950e45325 Mention index, get and the fact that all but ALPHA keys are case-sensitive to docs 2022-04-25 17:50:26 +00:00
cole smith
88cbbc6a90 Apply suggestions from code review 
Thank you for sticking with me, I really appreciate it. I will try and only need to be told once

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
 2022-04-25 16:54:08 +00:00
Cole Smith
49b83305d9 fixing docs 2022-04-25 16:54:08 +00:00
Cole Smith
e67a1a8cd7 added on to the docs for splits using encoders 2022-04-25 16:54:08 +00:00
Ryan Rotter
da239e535e minor typo in rgb.md 2022-04-25 16:53:22 +00:00
Ryan Rotter
9e171abc69 Capitalize Python class names 2022-04-25 16:53:22 +00:00
Ryan Rotter
9733c43d2a nice!nano spelling, broken link, bulleted lists 2022-04-25 16:53:22 +00:00
Ryan Rotter
dfa73a8cca add backtick quotes for code snippets 
* Added for keycodes, pin numbers, and code snippets. Mostly in tables.
* Enhance documentation readability
* Make automated spell checking easier - aspell automatically ignores these snippets
* fix invalid markdown table in mouse_keys.md
 2022-04-25 16:53:22 +00:00
Ryan Rotter
1985712637 spelling/capitalization/usage on proper nouns 
correct usage sourced from:
  * websites of respective trademark holders
  * Wiktionary
  * Wikipedia
 2022-04-25 16:53:22 +00:00
Ryan Rotter
09d0287800 Correct spelling of common words in .md files 2022-04-25 16:53:22 +00:00
xs5871
c7eaeaf90c implement multiple pixelbuffer in rgb extension 2022-04-24 10:20:22 -07:00
ldsands
651e203cb7 Updated OneShot doc with example OneShot Modifier Combination 2022-04-20 15:58:53 -07:00
xs5871
1700aff408 implements scanner with rotaryio 2022-04-17 18:33:34 -07:00
xs5871
f7dac9e96e add documentation 2022-04-17 18:33:14 -07:00
levpopov
a210c2bf62 Update Officially_Supported_Microcontrollers.md 2022-04-14 10:57:42 +00:00
levpopov
c8df1d10ad nice!nano compile instructions 2022-04-14 10:57:42 +00:00
xs5871
d2e87b3e70 add keypad scanner for shift registers 2022-04-12 08:29:23 -07:00