Commit graph

20 commits

Author SHA1 Message Date
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
KemoNine
784ddfc620 Add note about cmake 3.19 not working with zephr ; addresses issue #487 2020-12-08 00:41:33 -05:00
KemoNine
f8af592a9c Update cmake note to be 3.15 which is the current minimum version. This is a re-implementation of GitHub PR 403 2020-12-02 16:01:20 -05:00
Okke Formsma
c067629c83 Create west test command to run zmk testsuite. 2020-11-21 14:47:01 -05:00
innovaker
2744f44e73 refactor(docs): Integrate Dev Guides into Development section
Improves discoverability.
2020-11-20 22:31:56 -05:00
innovaker
2d50302a02 refactor(docs): Integrate USB Logging into Development section
Improves discoverability.
2020-11-20 22:31:56 -05:00
innovaker
532c1987b2 refactor(docs): Move dev- documents into /development
Aligns to conventions introduced by newer documentation.
2020-11-20 22:31:56 -05:00