kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
1381 commits 18 branches 0 tags 93 MiB
Commit graph

428 commits

Author SHA1 Message Date
KemoNine
dbf4e05663 Cleanup documentation to read easier and have more readable conventions. Expand some notes and caution boxes so some pitfalls and ways to improve performance are more clear to users 2021-03-02 19:06:17 +00:00
KemoNine
23dad0ae11 Fixup broken URLs based on CI feedback 2021-03-02 19:06:17 +00:00
KemoNine
fa39132c2a Slice up the development environment setup some included changes: 
- Give a brief overview of docker+vscode vs native os
- Dedicated page for docker+vscode setup
- Dedicated page for native os setup
- Dedicated page for setting up zmk sources for development
 2021-03-02 19:06:14 +00:00
Okke Formsma
0c1940bb79 feature(hold-tap): no-hold-flash for retro taps 
This is an improvement on retro-tap, solving the 'flashing hold' issue
users people experience.

When the tapping-term expires, the hold key is normally pressed. When
retro-tap is enabled, this is undesirable; only an interrupted hold-tap
should trigger the hold behavior.

This change disables the hold behavior for the 'STATUS_HOLD_TIMER'
state when retro-tap is enabled, and makes sure the
'STATUS_HOLD_INTERRUPT' state will be triggered when appropriate.
 2021-02-24 07:24:27 -05:00
Okke Formsma
89ed816c67 feature(hold-tap): Retro tapping 2021-02-24 07:24:27 -05:00
Okke Formsma
af9d6e9b05 style(hold-tap)!: Write hold-tap params with dashes 
tapping_term_ms -> tapping-term-ms
quick_tap_ms -> quick-tap-ms

The old style works, although it's deprecated.
 2021-02-10 07:55:12 -05:00
Joel Spadin
24ed1a8eaa docs(vscode): add more info for compile_commands.json path 2021-02-09 00:45:55 -05:00
Joel Spadin
0955ffef65 docs: Add docs for setting up vscode 
Added a docs page with tips for setting up VS Code's code completion to work
in ZMK's source files. Info for other IDEs can be added here later as needed.
 2021-02-09 00:45:55 -05:00
Pierre Constantineau
b67156b3f4
feat(docs): Update to BlueMicro_BLE Features 2021-02-08 10:48:12 -05:00
Pete Johanson
ae5056d680 Update docs/docs/behaviors/bluetooth.md 
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
 2021-02-04 07:45:55 -05:00
Jonathan Rascher
1368a6481e docs: Explain ZMK stays connected to inactive host 
This behavior was not obvious to me, and I actually considered reporting
it as a bug until @Nicell explained to me on Discord that it's WAI. :)
 2021-02-04 07:45:55 -05:00
KemoNine
cd503ed17b
Feat combo layers (#661) 
feat(combos): add layer filtering

Co-authored-by: KemoNine <mcrosson@kemonine.info>
 2021-02-03 23:33:09 -05:00
y4m4ym
9205ea1c70
fix(setup): Fix index to MakerDiary m.2 board 2021-02-03 23:10:47 -05:00
Okke Formsma
9a7908b632 behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD) 
Tap-and-hold a hold-tap to hold the tap behavior so it can repeat.
After a tap, if the same key is pressed within `quick_tap_ms`, the
tap behavior is always picked.

This is useful for things like `&ht LSHFT BACKSPACE` where holding
the backspace is required.

Implements #288.
 2021-02-02 15:28:16 -05:00
Aaron Nunley
bcc3d9b5a6 Update build/flash documentation. 
Updated docs for the build and flash to have similar content to the new board page.

Added a bit about DFU in case someone were searching for that term.
 2021-02-02 01:02:54 -05:00
Aaron Nunley
592b98cd12 npm run prettier:format 2021-02-02 01:02:54 -05:00
Aaron Nunley
100d06ae8b Update docs for testing a new shield. 
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
 2021-02-02 01:02:54 -05:00
Nick Winans
f39121f82e fix(docs): Remove comment about here being four profiles for splits 2021-01-30 00:36:18 -05:00
innovaker
40694a0969 docs: remove redundant slash from "docs/" navigation item 
Aligns with the blog item.

PR: #608
 2021-01-30 00:02:11 -05:00
Nick Winans
ddc5cbdca2 fix(docs): Set description to our tagline 2021-01-29 23:58:42 -05:00
Nick Winans
cba85d400d fix(docs): Only show push workflow builds in link 2021-01-29 22:09:22 -05:00
KemoNine
1adb2d5f84 feat(docs): add information on how to update the documentation to the docs 2021-01-29 20:44:39 -06:00
Pete Johanson
a89d8a6ea4 fix(blog): Updated link to combos docs. 2021-01-27 22:49:57 -05:00
Pete Johanson
1addfb9769 feat(blog): Add SOTF #4 2021-01-27 22:48:14 -05:00
Okke Formsma
89567d3150 docs(sticky keys): document sticky keys and sticky layers 2021-01-24 23:30:05 -05:00
Pete Johanson
e8aa576781 refactor(docs): Move combos under Features. 
* Since combos aren't a behavior, but a new high level keymap
  feature, move under Features section.
 2021-01-24 16:42:44 -05:00
innovaker
13e46bea81 docs(hold-tap): mark tapping_term_ms as code 
Improves readability and consistency.
 2021-01-21 07:57:33 -05:00
Okke Formsma
feb0d5b90c feat(combos): initial implementation 
closes #45
 2021-01-13 21:07:41 -05:00
innovaker
90c2c6672f fix(setup.sh): rename BF0-9000 to BFO-9000 
Replaces BF0 (zero) with BFO.

Refs: dcd665999a
PR: #595
 2021-01-13 21:00:38 -05:00
Nick Winans
0c6686f6e8 docs(split): Remove USB configuration on right half 2021-01-08 16:51:50 -05:00
KemoNine
af563e9dbc Fix parameter number 2021-01-08 16:08:13 -05:00
KemoNine
79b4a0ea6f Add RGB_COLOR_HSB to lighting documentation 2021-01-08 16:08:13 -05:00
Nick Winans
167600f01d docs(logging): Update documentation on USB logging 2021-01-08 13:03:39 -05:00
Pete Johanson
964b613e98 fix(setup): Fix typo for split variable assignment 2021-01-08 11:11:20 -05:00
innovaker
f0312092c7 fix(setup.sh): add NIBBLE to options 
This was missing from its original commit.

Refs: f3153b17d2
 2021-01-08 11:02:35 -05:00
innovaker
f17584ca0e chore: standardize # style headers 
Changes made with regex plus some manual tweaks.

Find:
/(?:(?<!#!\/bin\/sh\n)(?:^#\n))*^#.*?[Cc]opyright.*?(\d{4}) *([0-9A-z,_\- ]+).*?\n(?:^#\n)*^#.*?SPDX-License-Identifier:? *(.+) *?\n(?:^#\n)*/gm

Replace:
# Copyright (c) $1 $2
# SPDX-License-Identifier: $3

PR: #564
 2021-01-06 17:00:44 -05:00
Nick Winans
56ec200bae docs(intro): Add 💡 to Mouse Keys and BLE Shell 2021-01-05 19:37:00 +00:00
Nick Winans
ad238d63df docs(intro): Update feature table 2021-01-05 19:37:00 +00:00
Okke Formsma
4c1f615714
docs(troubleshooting): fix reset uf2 download instructions 
PR: #512
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
 2021-01-05 19:29:47 +00:00
KingCoinless
5c11962d98
feat(shields): add helix shield 
PR: #429
 2021-01-05 18:56:47 +00:00
Nick Winans
a470353760 docs(shield): Add docs based on #510 changes 2021-01-04 14:08:00 -05:00
Pete Johanson
74b397ab91 fix(docs): Add closing bracket for new shield. 2021-01-04 11:59:25 -05:00
Nick Winans
4ddda7e024
docs(shield): Remove SPLIT_BLE_ROLE_PERIPHERAL 
Removes CONFIG_ZMK_SPLIT_BLE_ROLE_PERIPHERAL from the new shield docs

See: #510
Refs: 4db5b169bf
 2021-01-04 00:13:49 +00:00
pbz
dcd665999a
feat(shields): add bfo9000 shield 
PR: #472
 2021-01-02 18:52:50 +00:00
Mango The Fourth
5752b4fbda
feat(shields): add eek shield 
PR: #529
 2021-01-01 14:33:19 +00:00
Stephen Wu
2b4fda6948
docs(codes): improve macOS support data (volume, brightness, media controls) 
Codes:
- K_VOLUME_UP, C_VOLUME_UP, K_VOLUME_DOWN, C_VOLUME_DOWN, K_MUTE
- C_BRIGHTNESS_INC, C_BRIGHTNESS_DEC
- C_PLAY_PAUSE, C_NEXT, C_PREVIOUS

Tested on:
- Catalina 10.15.7
- Big Sur 11.2 Beta

PR: #541
See: #375
 2021-01-01 11:06:40 +00:00
Pete Johanson
39490552f2 feat(boards): Add BDN9 Rev2 board. 
* Onboard stm32f072.
* 3 possible encoder positions.
* Underglow/per-key not yet support.
 2020-12-31 14:46:15 -05:00
KemoNine
d207c3c30f
(feature) Add &to keycode/behavior (#489) 
feat(behaviors): Add `&to` behavior to switch to a layer.
 2020-12-29 11:57:49 -05:00
innovaker
842aa5a842 refactor: replace filename hyphens with underscores 
Aligns *.h and *.c to underscore naming convention.

These were kept (with warnings) for backwards compatibility with external boards/shields:
- kscan-mock.h
- matrix-transform.h
They should be removed in the future.

PR: #523
 2020-12-28 01:15:35 -05:00
innovaker
8fd9b619a7 docs(setup): bump Zephyr SDK version to 0.11.4 
Latest stable version.  Also used in zmk-docker images.
 2020-12-18 09:40:39 -05:00