Commit Graph

56 Commits

Author SHA1 Message Date
Kyle McCreery 70aa4fa824
feat(boards): Add PillBug board, blackpill interconnect.
* Add blackbill interconnect metadata.
* Add config/overlay for upstream blackpill boards to work with ZMK.
* Add pillbug board.
* Updated new shield docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-10 22:01:37 -06:00
Joel Spadin 6ccb5280c9 fix(docs): Pin Zephyr docs links to a version
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-08 01:00:48 -06:00
Joel Spadin 593db85378 feat(boards): Add support for nRF5340 DK
Added overlays to support building for the nRF5340 development kit.

Also added some documentation on how to build and flash ZMK for dual-
chip Bluetooth configurations, with an example for the nRF5340.
2022-12-08 01:00:48 -06:00
byran.tech c7d83fb951
fix(docs): changed MacOS to macOS as per Apple styling 2022-11-09 20:38:08 -06:00
byran.tech b21ddcf79a
fix(docs): added concrete number for Bluetooth advertising name length
* Update new-shield.md
* Update config docs.
2022-08-19 10:29:12 -04:00
Cem Aksoylar 41c9d81096 fix(docs): Update config docs for split Kconfig refactor 2022-07-05 08:42:27 +01:00
Cem Aksoylar 851c37e14f fix(docs): Apply suggestions from #722 reviews 2022-07-05 08:42:27 +01:00
Yomi Ikuru 6150ad65c4
feat(docs): Add tip for improving build times 2022-05-31 21:32:13 +01:00
Peter Johanson 6539b3ae25 refactor(split): Clean up Kconfig organization.
* Seperated configs for split role (central/peripheral)
  and transport (BLE only for now).
* Split the configs to align on structure.
2022-05-29 19:18:09 -04:00
Kurtis Lew 8a70d5fccc
feat(docs): Add New Behavior Guide
Co-authored-by: Henré Botha <henrebotha@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
2022-05-21 17:26:10 +01:00
Peter Johanson 64dadfb336 refactor(tests): Move remaining tests to posix 64.
* Update docs and fix up a few lingering tests
  to consistently use native_posix_64 target.
2022-05-19 10:55:23 -04:00
Cem Aksoylar 32c8737a22 fix(docs): Fix cmake version requirements 2022-04-08 07:18:44 -04:00
Peter Johanson 3c4ff9c82c fix(docs): Proper links to new SDK version. 2022-04-03 00:10:29 -04:00
Dom H 322cc14da6 fix(docs): Remove trailing whitespace
Otherwise, prettier fails.
2022-02-16 15:29:02 +00:00
chadbailey59 43ffa6c760
docs: Clarifications within New Shield page (#1130)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-02-16 11:46:15 +00:00
Alessandro Bortolin da41391b1f feat(docs): add backlight documentation 2022-02-05 23:40:18 -05:00
Evan Callicoat be343674de
docs: Fix typos and inconsistent spellings (#1079) 2022-01-02 10:34:21 +00:00
Ivan Smirnov 3114ce00b9
docs: reiterate building from `zmk/app/` (#1031)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2021-12-28 10:52:16 +00:00
jmding8 19ee7849f8
feat(behaviors) Required keys for tap-hold behaviors
* Add optional `hold-trigger-key-positions` hold-tap configuration
* Leverage configuration for decision making around when to trigger
  hold decision in hold-taps.
* Add docs for new configuration.
* Tests for the new config/decision logic.
2021-11-01 12:37:20 -04:00
Jonathan Rascher 96fea949d5 docs(docs): Document up-to-date Node.js repo
For example, Debian Bullseye (current stable) packages Node.js version
12, which is too old to build the docs successfully. At least version 14
is required, and version 16 is current. General advice seems to be to
install from the NodeSource repo instead of your distro's repo, so I
added a suggestion to the docs.
2021-10-10 12:20:35 -07:00
Nick Winans e6645882c3 feat(docs): Update documentation to match new Pro Micro nodes 2021-09-25 23:09:21 -04:00
Nick Winans 10870b24bf fix(docs): Update split naming system 2021-09-25 21:17:24 -04:00
Dom H c52887e236 fix(docs): Remove build.yml from new shield steps 2021-09-22 17:35:08 -04:00
Richard Titmuss d769618b3f fix(docs): Remove unnecessary security warning for MacOS
The security warning applies for downloaded executables. If you are
following the instructions the toolchain is installed with brew and
the security warning does not apply. This is explained in the removed
link.
2021-09-17 10:43:48 -04:00
Cem Aksoylar 33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config 2021-09-14 20:51:05 -04:00
Peter Johanson 7bf68f2a00 refactor(docs): Remove build.yml for new shield.
* No longer recommending that all new shields get added to the
  build matrix in `build.yml`, so we avoid conflicts.
2021-09-11 00:50:36 -04:00
Peter Johanson f8e88d78c4 docs: Add docs on hardware metadata files. 2021-09-11 00:50:36 -04:00
Nick Winans d964faaa89 fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
innovaker a8c0c76fca docs(setup): replace `zephyr-west-action` with `zmk-docker`
This should've been changed after #481.

See: https://github.com/zmkfirmware/zmk/pull/481
PR: https://github.com/zmkfirmware/zmk/pull/845
2021-07-18 03:52:45 +01:00
innovaker 47043c86e9 docs: bump Zephyr documentation links to Zephyr v2.5.0
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17 17:04:25 -04:00
innovaker c03046e54a docs(setup): add `x86_64-linux` to Zephyr SDK setup filename
See: zmkfirmware/zmk-docker@b8341e185a
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17 17:04:25 -04:00
innovaker 76979d293a docs(setup): bump `ZSDK_VERSION` to `0.12.4`
PR: https://github.com/zmkfirmware/zmk/pull/736
2021-07-17 17:04:25 -04:00
innovaker 576ce76ad3 docs(setup): fix whitespace in Fedora toolchain install command
Aligns Fedora whitespace with Debian.
2021-06-16 16:23:53 -05:00
innovaker 84a5fec458 docs(setup): remove extra slash from Fedora toolchain install command 2021-06-16 16:23:53 -05:00
innovaker 6f3a2529ae docs(setup): fix whitespace mismatch in host dependencies
Replaces spaces with tabs (bzip2).
2021-06-16 16:23:53 -05:00
Ivan Smirnov bb32005474
fix(docs): Update macos GCC embedded section with brew cmd
* Update macos GCC embedded section with brew cmd

Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.
2021-06-08 20:56:10 -04: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
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
KemoNine 1adb2d5f84 feat(docs): add information on how to update the documentation to the docs 2021-01-29 20:44:39 -06:00
Nick Winans 0c6686f6e8 docs(split): Remove USB configuration on right half 2021-01-08 16:51:50 -05:00
Nick Winans 167600f01d docs(logging): Update documentation on USB logging 2021-01-08 13:03:39 -05: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
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
innovaker 8a529163fc docs(logging): remove CONFIG_USB_UART_DTR_WAIT
This configuration option was removed in Zephyr v2.4.0.

See: zephyrproject-rtos/zephyr#27427
PR: #467
2020-12-14 12:41:25 -05:00