pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
1310 commits 1 branch 0 tags 16 MiB
Commit graph

401 commits

Author SHA1 Message Date
Nick
aa4ae90fb7 Add missing configuration values for RGB underglow 2020-08-14 21:31:18 -05:00
Cody McGinnis
c3b4525d25 Fix edit url links for the website. 2020-08-13 00:19:59 -04:00
Pete Johanson
0624c6c54a State Of The Firmware #1. 2020-08-12 10:20:51 -04:00
Pete Johanson
a6ef1cddec Add analytics. 2020-08-11 16:55:36 -04:00
Pete Johanson
47dbba2184 Fix sed -i usage on macOS, accept 'Y'. 2020-08-11 08:40:13 -04:00
Pete Johanson
b0c648ad57 Revert usage of read -i for macOS compat. 2020-08-10 22:47:18 -04:00
Pete Johanson
bc6b11eb02
Merge pull request #78 from Nicell/docs/rgb 
Add RGB documentation
 2020-08-10 13:46:46 -04:00
Pete Johanson
579ca63120
Merge pull request #80 from petejohanson/shields/corne-initial-definition 
Initial Corne shield definition
 2020-08-10 12:58:04 -04:00
Pete Johanson
4da2070a5b Add Corne to hardware list. 2020-08-10 12:54:34 -04:00
CrossR
03a945d423 Move to correct location. 2020-08-10 17:51:54 +01:00
CrossR
3f74814379 Quick doc update. 2020-08-10 17:43:57 +01:00
Pete Johanson
851d54ad96 Add Corne to setup.sh script. 2020-08-10 12:37:05 -04:00
Nick
fd77fdb63d Fix video container size 2020-08-08 19:10:10 -05:00
Nick
d901a0061d Add underglow feature docs + DT fixes 2020-08-08 19:02:00 -05:00
Nick
c92f114efe Add lighting behavior docs 2020-08-08 17:23:11 -05:00
Pete Johanson
e2848c66c3 Fix to archive the .hex files for proton-c build. 
* Closes #77.
 2020-08-08 17:28:00 -04: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
5039a50831 Tweak git usage for backwards compatibility. 
* Closes #76
 2020-08-07 23:35:48 -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
ccb9b9309a Script fixes, ability to prepopulate a keymap. 
* Use read w/ -i for initial default values.
* Prompt for fetching keymap for customization,
  and grab latest from `main` if opted in.
* Don't copy `prj.conf` from the template,
  pull the `<shield>.conf` from `main` also.
 2020-08-07 10:02:44 -04: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
6fd572d3b6 Use process.env.URL instead of DEPLOY_URL. 2020-08-05 14:58:25 -04:00
Pete Johanson
f71f12f5a8 Build fixes. 2020-08-05 14:51:31 -04:00
Pete Johanson
aa21bdd79a Tweak for dynamic invite URL for deploys. 2020-08-05 14:43:59 -04:00
Pete Johanson
e1ea833bb3 Flesh out documentation skeleton. 2020-08-05 14:04:08 -04:00
Pete Johanson
db586b1ce0 Update to latest V2 Docusaurus. 2020-08-05 14:02:37 -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
e9c2b84c82 Initial setup.sh version. 2020-08-04 13:41:07 -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
2d99e69eb7
Add Netlify deploy badge 2020-07-21 19:58:34 -04:00
Pete Johanson
22c0558b2f Community link fixes. 2020-07-20 23:39:19 -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
3cc8b96ac8 Updated link to Discord invite. 2020-07-03 10:45:50 -04:00
Pete Johanson
87cd83ddb6 Move the netlify.toml file into docs/ 2020-07-03 10:43:27 -04:00
Pete Johanson
22238d24de Add Algolia search config. 2020-06-29 10:20:07 -04:00
Pete Johanson
c96e705e2e A few more master to main fixes. 2020-06-17 10:38:15 -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
82d0bd860d docs: Add "sidebarCollapsible: false" 2020-06-14 14:23:48 +01: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
c14beb7ee7 docs: Switch positions of 'hardware' and 'faq' on sidebars [#22 CR, #11] 2020-06-13 19:54:55 +01:00
innovaker
30985517b8 docs: add faq to sidebars [#11] 2020-06-13 18:47:20 +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
innovaker
d11ade45d3 [#16] Replaced 'Basics' with 'Getting Started' 2020-06-12 16:08:20 +01:00
Pete Johanson
16f9c4e715
Merge pull request #9 from Nicell/docs/update_docs_landing_page 
Update landing page content and style
 2020-06-10 23:11:35 -04:00
Nick
fa4519b596 Add missing button border definition 2020-06-10 22:07:21 -05:00
Nick
6af0f9f06e Add missing border change 2020-06-10 22:03:52 -05:00
Nick
b7eeaeb941 Update landing page content and style 2020-06-10 21:58:31 -05: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
a952cd6899 Title fix, remove redundant "keyboard". 2020-06-09 23:24:19 -04:00
Pete Johanson
e9d7c54b1c New logo and color palette. 2020-06-09 23:18:12 -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
6b48b6dadd Initial cleanup of docs template, GitHub URLs, etc. 2020-06-08 23:10:48 -04:00
Pete Johanson
c1cc46c3b2 Updated favicon for the docs site. 2020-06-08 11:07:08 -04:00
Pete Johanson
5304ff9c77 Basic ZMK logo. 2020-06-08 10:46:38 -04:00
Pete Johanson
84dcf3715f Typo fix for the intro page. 2020-06-08 10:41:02 -04:00
Pete Johanson
f1afbb8e49 Some basic docs clean up. 2020-05-31 15:35:32 -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