Commit graph

293 commits

Author SHA1 Message Date
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
Pete Johanson
5cebba1637 Various docs fixes, including PR feedback. 2020-06-10 00:05:28 -04:00
Pete Johanson
a709e95680 Fill out dev setup even more. 2020-06-09 23:15:02 -04:00
Pete Johanson
4ea641f34a Typo fix, add ™ properly. 2020-06-09 17:00:22 -04:00
Pete Johanson
7cb7d705d6 Improved dev setup docs. 2020-06-09 16:35:47 -04:00
Pete Johanson
1ba66e7dbe Nix Bluetooth in favor of BLE for now. 2020-06-09 15:50:46 -04:00
Pete Johanson
dbabeffa8a Properly reference MIT license consistently. 2020-06-09 09:52:26 -04:00
Pete Johanson
84dcf3715f Typo fix for the intro page. 2020-06-08 10:41:02 -04:00
Pete Johanson
749df61a2e Add docs about clean room design. 2020-05-31 10:54:14 -04:00
Pete Johanson
dfd5bc0586 More complete intro to the project. 2020-05-26 11:55:58 -04:00
Pete Johanson
e00408d746 Initial work on basic documentation. 2020-05-25 21:33:21 -04:00