zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
416 Commits 29 Branches 7 Tags 111 MiB
Commit Graph

60 Commits

Author SHA1 Message Date
Nick c92f114efe Add lighting behavior docs 2020-08-08 17:23:11 -05:00
Pete Johanson 483530e0ad Basic key press/consumer press behavior docs. 2020-08-08 17:10:12 -04:00
Pete Johanson 85d35c7ff9 Tweak the pip PATH callouts. 2020-08-08 12:25:54 -04:00
Pete Johanson b25133cbef Add a layer diagram. 
* Original diagram from Thomas Baart, used
  with permission.
 2020-08-07 16:45:11 -04:00
Pete Johanson dd8deceed0 Add basic layer behavior docs. 2020-08-07 16:29:52 -04:00
Pete Johanson 3b841c65bb Typo fix (thanks @Nicell). 2020-08-07 15:58:09 -04:00
Pete Johanson 4b310abb3d Remove broken import. 2020-08-07 15:30:37 -04:00
Pete Johanson 5418918e13 Explicitly use bash. 2020-08-07 15:15:04 -04:00
Pete Johanson 14eef91da1 Better user setup docs. 2020-08-07 15:05:25 -04:00
Pete Johanson afc1c38866
Merge pull request #75 from careyk007/main 
Update dev-setup.md
 2020-08-07 12:09:32 -04:00
Kellen Carey 5bfa4ba3ff
Update dev-setup.md 2020-08-07 08:58:07 -07:00
Pete Johanson 5c10517c29 Show the complete keymap example inline. 2020-08-07 09:36:48 -04:00
Pete Johanson ec4c12501c Fix up the keymap docs after the DT refactor. 2020-08-07 09:31:12 -04:00
Pete Johanson 10683fe1f8 Docs re-org, start of some keymap docs. 2020-08-06 15:04:31 -04:00
Pete Johanson 9233ab60cd Minor fix for USB logging to work on peripherals. 2020-08-05 22:59:58 -04:00
Pete Johanson f71f12f5a8 Build fixes. 2020-08-05 14:51:31 -04:00
Pete Johanson e1ea833bb3 Flesh out documentation skeleton. 2020-08-05 14:04:08 -04:00
Pete Johanson 761601be5b Typo fix. 2020-08-04 14:19:32 -04:00
Pete Johanson 977259f906 Better wording on user setup intro. 2020-08-04 14:15:23 -04:00
Pete Johanson fedd4381c2 Initial user setup docs, setup script fixes. 2020-08-04 14:12:10 -04:00
Pete Johanson b7e1509413 Updated intro that better outlines features. 2020-08-03 23:48:17 -04:00
Pete Johanson 35c8b6b434 Improved hardware docs. 2020-08-03 23:44:53 -04:00
Pete Johanson c23c44a4c4 Fix the default OS tab. 2020-07-14 10:24:51 -04:00
Pete Johanson 8dcb03faa6 Tweaks for highlighting. 2020-07-14 06:40:53 -04:00
Pete Johanson dd34edace1 Remaining fixes. 2020-07-14 00:12:54 -04:00
Pete Johanson dca81c6579 Tweaks for multiple OS stuff. 2020-07-13 23:48:26 -04:00
Pete Johanson 092fa866af Add doc on enabling USB logging. 2020-07-07 11:58:12 -04:00
Pete Johanson 4fb98e04f2 Add missing `id` header. 2020-07-07 10:54:28 -04:00
Pete Johanson 48f3f86a83 Initial shield dev guide. 2020-07-06 23:30:07 -04:00
Pete Johanson bd1e2b069b Expanded dev docs on boards/shields/keymaps. 2020-07-06 11:40:03 -04:00
Pete Johanson da5d5f988f Fix links to docs from the FAQ. 2020-06-17 10:37:36 -04:00
Pete Johanson 766eedebe5 Move the gcc-multilib install to POSIX board doc. 2020-06-15 23:16:02 -04:00
Pete Johanson c2e0c4fd6c Fix some whitespace inconsistency. 2020-06-15 23:13:44 -04:00
Pete Johanson 789af69e52
Merge pull request #19 from petejohanson/docs/python-requirements-base-tweak 
Only install `requirements-base.txt`
 2020-06-14 23:22:03 -04:00
innovaker a109de24b2 docs: faq: Replace all instances of "board" and "shield" with links [#22 CR, #11] 2020-06-13 20:02:24 +01:00
innovaker 726b40cfa2 docs: faq: Add preface links to "Why boards and shields?" [#22 CR, #11] 2020-06-13 20:02:24 +01:00
innovaker 70edcd4a3a docs: initial version of faq.md [#11] 2020-06-13 18:44:35 +01:00
Pete Johanson 4a39299db8 Only ask users to install requirements-base.txt. 2020-06-12 15:12:05 -04:00
Pete Johanson 3d221053da Initial code of conduct documentation. 2020-06-10 21:11:49 -04:00
Pete Johanson b83b8c6a69
Merge pull request #4 from zmkfirmware/docs/better-dev-setup-instructions 
Improved dev setup docs.
 2020-06-10 21:00:27 -04:00
Pete Johanson 8a81dbb5fb Split apt update and install into two sections. 2020-06-10 20:58:32 -04:00
Pete Johanson 86da8f8875
Remove note about wb55rg USB issues, consumer keys 2020-06-10 19:04:32 -04:00
Pete Johanson 8527102bb9 Add a note about older Ubuntu LTS and CMake. 2020-06-10 11:23:42 -04:00
Pete Johanson 20545ea4fa Add note about possible missing `west` command. 2020-06-10 11:18:22 -04:00
Pete Johanson 43008494c4 Header level fix. 2020-06-10 11:07:20 -04:00
Pete Johanson 6ef823be3a More doc tweaks for SDK install and build clarity. 
* Suggest installing SDK to `~/.local` directory.
* Clarify about switching to `app/` before build/flash.
 2020-06-10 11:00:03 -04:00
Pete Johanson 2f4bc94b7e Tweaks to sourcing the `zephyr-env.sh` script. 2020-06-10 10:31:21 -04:00
Pete Johanson 9e62cc7069 Fix a `.zephyrrc` typo. 2020-06-10 10:30:28 -04:00
Pete Johanson 35d07cff17
Apply suggestions from code review 
Co-authored-by: Nick Winans <nick@winans.codes>
 2020-06-10 10:06:55 -04:00
Pete Johanson 2c63214c7d A few more missing build steps. 2020-06-10 00:13:55 -04:00