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

672 commits

Author SHA1 Message Date
KemoNine
784ddfc620 Add note about cmake 3.19 not working with zephr ; addresses issue #487 2020-12-08 00:41:33 -05:00
ReFil
b0c525df72
feat(shields): add CRBN shield 
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
PR: #483
 2020-12-07 16:49:37 +00:00
KemoNine
9c1a544381 Add note about default number of available profiles and how to increase if desired 2020-12-06 22:55:31 -05:00
KemoNine
52df05a545 Tweak/cleanup bluetooth documentation so it's more clear which codes should be used in keymaps as well as to call attention to BT_SEL requiring a second parameter 2020-12-06 22:55:31 -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
Nick
a1d3230eef feat(underglow): RGB toggle controls ext_power 
fix(ug): Don't return if finding ext power fails

fix(ug): Move ext_power to a static variable

Add #if defs
 2020-11-22 21:23:29 -05:00
Okke Formsma
6573483a10 update errors in mod-tap docs 2020-11-22 21:06:42 -05:00
innovaker
3ebd192411 docs(key-press): remove references to key press 
This was obsoleted by eff1b8223b
 2020-11-21 15:23:11 -05:00
Okke Formsma
c067629c83 Create west test command to run zmk testsuite. 2020-11-21 14:47:01 -05:00
Okke Formsma
5d0532c6d9 improve hold-tap docs with better homerow example and more about flavors 2020-11-21 11:14:10 -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
Cody McGinnis
da08b4852d fix(setup): make sure selections are numbers 2020-11-19 19:32:53 -05:00
innovaker
3e65f6d472 docs(hold-tap): Capitalize hold-tap behavior document title 
Aligns with other documents.
 2020-11-18 10:47:59 +00:00
innovaker
bb43c7e053 docs: Rename someSidebar to docs 2020-11-18 10:47:08 +00:00
innovaker
c57c70465a fix(docs/codes): Patch footnotes array support 
Fixes bug that was noticeable when more than one code with a footnote array was present in a table.  The symptoms were:
- footnote descriptions were duplicated
- footnote refs were not rendered
 2020-11-18 10:45:40 +00:00
Caleb Lightfoot
d5250f0449 docs: Fix typo in PowerShell install script 
When I documented the PS install script in #210 I made a typo on the end.
 2020-11-17 20:56:27 +00:00
Caleb Lightfoot
3adbdffd0c docs: Add wired split FAQ 2020-11-17 20:56:27 +00:00
Caleb Lightfoot
4a8a6c58fb docs: Remove outdated HID note 
Removed outdated HID note from key-press.md
 2020-11-17 20:56:27 +00:00
krikun98
f60439802d Jian shield 2020-11-17 16:23:39 +00:00
krikun98
3d030ec2ab Jorne shield 2020-11-17 16:23:39 +00:00
Chiyuan Zhang
9388b24e7a zmk-config mounting based on docker volume 2020-11-16 22:49:20 -05:00
innovaker
28a4f33ee7 refactor(docs): Extract keymap examples into their own files 
Eases maintenance and promotes reuse.
 2020-11-16 21:39:38 -05:00
innovaker
18079e3bd3 fix(docs): Remove obsolete VID/PID CMake error 
This was obsoleted by 36d3d01a22.
 2020-11-16 17:33:59 -05:00
innovaker
6cf13f6b80 docs(key-press): Change codes to usages 
`usages` is a more accurate term in this context.
 2020-11-16 17:32:51 -05:00
innovaker
2871dca9bf refactor(docs): Change behavior to behaviors 
Makes a better URL.
 2020-11-16 15:33:44 -05:00
innovaker
a685d88744 refactor(docs): Change feature to features 
Makes a better URL.
 2020-11-16 15:33:44 -05:00
innovaker
aa8d0c1c79 refactor(docs): Remove explicit document ids (part 2) 
This was missed in: 4d42e792c5
 2020-11-12 07:42:48 -05:00
innovaker
4d42e792c5 refactor(docs): Remove explicit document ids 
Aligns older documents with newer file-based ids.
 2020-11-11 23:40:49 -05:00
Okke Formsma
d5cc504b3a docs: update modifier docs 2020-11-11 14:04:35 -05:00
Nick
ae51000d60 fix(underglow): Switch from legacy SPI to SPIM 2020-11-10 23:06:29 -05:00
Pete Johanson
0031f9bd4d
Merge pull request #357 from petejohanson/ble/remove-unpair-combo 
fix(ble): Remove unpair combo code.
 2020-11-10 15:04:28 -05:00
Pete Johanson
7d16186b7a fix(ble): Remove unpair combo code. 
* Favor the settings reset images for this.
 2020-11-10 14:53:03 -05:00
Nick Winans
413a917d14
Merge branch 'main' into underglow/add-config_ 2020-11-10 13:31:11 -06:00
Pete Johanson
edcfe380fe fix(blog): Quefrency typo fix. 2020-11-09 17:00:52 -05:00
Pete Johanson
9fe1793691 feat(blog): SOTF #3 2020-11-09 16:12:03 -05:00
Nick
0be904c34f fix(underglow): Add CONFIG_ to underglow Kconfigs 2020-11-08 10:33:56 -06:00
Okke Formsma
0d02441abe docs(codes): add modifier functions 
Refactor and expand codes documentation to include modifier functions.

Closes #330.
 2020-11-07 12:00:19 -05:00
innovaker
5d04110a58 docs(key-press): Update for standardized keys 
Replace existing HID Usage Tables link with links to the new codes documentation.
 2020-11-06 15:02:12 -05:00
innovaker
642ec46c1f docs(intro): Update for standardized keys 
Update links to the new codes documentation.
 2020-11-06 15:02:12 -05:00
innovaker
ff638eb010 docs(codes): Add (key) codes documentation 
Create codes documentation for standardized keys.

Closes #218.  Fixes #308.  Ref #21.
 2020-11-06 15:02:12 -05:00
Pete Johanson
eff1b8223b refactor(keys): Unify usage page. 
* Remove need for separate `&cp` behavior, but
  keep it for now for backward compat.
* Refactor sensor inc/dec as well.
 2020-11-05 14:55:40 -05:00
innovaker
5f83568a93 docs(key press): Replace deprecated NUM_1 with N1 
This should've been changed in: b8f6d52ae5
 2020-11-05 11:47:34 -05:00
innovaker
651204c121 docs: Reformat example keymaps 
Align to wider columns to improve readability for newcomers.
 2020-11-03 23:50:54 -05:00
innovaker
b8f6d52ae5 docs: Replace deprecated key names 
Follow-up to #21.
 2020-11-03 23:50:54 -05:00
Joel Spadin
c3e7742f9c fix(docs): remove incorrect defines for outputs 
The output selection behaviors page still referenced defines that were
removed while reviewing the PR. Updated the docs to match the code.
 2020-11-03 19:38:56 -05:00
Nick
274fdec783 Add blog post about #322 2020-11-03 15:56:20 -05:00
Pete Johanson
fe62929af8 feat(docs): Add eslint and prettier GH Actions. 2020-11-03 15:02:41 -05:00
innovaker
a1dd216519 docs: formatted with prettier 2020-11-03 08:19:00 -05:00
Okke Formsma
4f258efbf1 initial implementation for modifiers 
https://github.com/zmkfirmware/zmk/issues/86
 2020-11-03 00:19:37 -05:00
Chiyuan Zhang
a9e729b427 make note about keyboard name more explicit 2020-11-02 23:30:03 -05:00
Chiyuan Zhang
9b941b7509 tweak doc according to PR feedback 2020-11-02 23:30:03 -05:00
Chiyuan Zhang
e7cb863a41 update doc for new shield in user repo 2020-11-02 23:30:03 -05:00
Evan
a32d14cc19 Add Github.com personal token to prerequisites. 2020-11-02 16:50:27 -05:00
innovaker
4672a0cbb5
docs(outputs): run prettier on outputs.md (#317) 
Fixes #269
 2020-10-31 12:00:02 -04:00
Pete Johanson
1766b090ee feat(docs): Warn of battery life impact of logging 2020-10-31 00:30:19 -04:00
Pete Johanson
7e0924107c feat(docs): Link to outputs behavior docs. 2020-10-31 00:23:16 -04:00
Joel Spadin
2fe1fbb526 feat(endpoints): rename behavior to outputs 
"Outputs" is probably easier for most people to understand than "endpoints".
 2020-10-28 18:15:05 -05:00
Joel Spadin
600bba25f0 feat(endpoints): add preferred endpoint setting 
Added a new setting to remember the user's preferred endpoint. When both USB and
BLE are connected, the preferred endpoint will be used.

Added a new behavior to control this setting. It supports commands:

    &end END_USB - Prefer USB output
    &end END_BLE - Prefer BLE output
    &end END_TOG - Toggle between USB and BLE
 2020-10-28 18:15:05 -05:00
innovaker
806ea545f8 docs: Set netlify node version to lts/* 
Prerequisite of #218 and PR #308.
 2020-10-26 22:55:15 +00:00
Pete Johanson
cb922fd8a2 feat(docs): Add Boardsource 3x4 to hardware list. 2020-10-27 23:32:44 -04:00
Jay Greco
d90592aac5 Add NIBBLE shield 
+ Added required files for nullbits NIBBLE
 2020-10-27 12:44:59 -07:00
Pete Johanson
3b9caaaf90
Merge pull request #304 from petejohanson/docs/cc-license-details 
Explicitly license documentation as CC-BY-NC-SA.
 2020-10-27 14:10:47 -04:00
Pete Johanson
2f09957ae2
Merge pull request #301 from innovaker/docs-eslint-prettier 
docs: Add eslint, prettier and eslint-mdx support
 2020-10-27 12:56:44 -04:00
Pete Johanson
c707ab45ef
Merge pull request #297 from Nicell/boards/reviung41 
Add Reviung41 Shield Definitions
 2020-10-27 00:27:17 -04:00
Pete Johanson
571d045c75 fix(docs): Explicit CC-BY-NC-SA license for docs. 2020-10-26 23:15:48 -04:00
Nick
1ac78498eb docs: Set prettier endOfLine to auto 
As discussed in PR #301.
 2020-10-26 05:28:31 +00:00
Nick
fd892d53cd fix: eslint proptype errors 2020-10-25 23:45:28 +00:00
innovaker
288e60ea97 docs: Format docs with prettier 
npx prettier --write .
 2020-10-25 21:25:08 +00:00
innovaker
aefcc592f2 docs: Add eslint-mdx support 
Official guidelines:
https://github.com/mdx-js/eslint-mdx

Steps taken:
npm i -D eslint-plugin-mdx
Edit .eslintrc.js
 2020-10-25 21:25:01 +00:00
innovaker
18d4d619e4 docs: Add prettier support 
Official guidelines:
https://prettier.io/docs/en/install.html
https://prettier.io/docs/en/integrating-with-linters.html
https://github.com/prettier/eslint-config-prettier

Steps taken:
npm install --save-dev --save-exact prettier
Create .prettierignore
Create .prettierrc.js
npm install --save-dev eslint-config-prettier
Edit .eslintrc.js
 2020-10-25 21:24:55 +00:00
innovaker
ab65bf49db docs: Add eslint support 
Official guidelines:
https://eslint.org/docs/user-guide/getting-started

Steps taken:
npm install eslint --save-dev
npx eslint --init
Create .eslintignore
Edit .eslintrc.js (tweaks)
 2020-10-25 21:23:16 +00:00
Pete Johanson
b1bfff5b5a
Merge pull request #264 from careyk007/setup_sh__curl_always_required 
Add support for wget to setup.sh
 2020-10-25 23:39:47 -04:00
innovaker
ca0bcc0ae4 docs: Add missing docusaurus scripts 
Add:
- docusaurus serve
- docusaurus clear
 2020-10-25 19:45:04 +00:00
Nick
7296b96797 Add Reviung41 Shield Definitions 2020-10-24 21:08:00 -05:00
Pete Johanson
518bcacba1
Merge pull request #280 from Tsquash/txpowerdocs 
DocumentedTX Power Config in Troubleshooting
 2020-10-23 12:36:28 -04:00
Caleb Lightfoot
1a6d373d16 Added Sentence For Link to Zephyr Docs 2020-10-21 19:57:46 -05:00
Caleb Lightfoot
d07a46a334 Changed Wording of Text 2020-10-21 19:44:49 -05:00
innovaker
0905302006 chore(docs): Docusaurus 2.0.0-alpha.66 2020-10-21 19:35:04 +01:00
innovaker
1e008728b7 chore(blog): Remove deprecated id: wip 
Fix warning ...
2020-05-24-wip.md - 'id' header option is deprecated. Please use 'slug' option instead.

Follow-up to #286.
 2020-10-21 13:52:45 +01:00
innovaker
cd683b8dd6 chore(docs): Replace homePageId with slug: / 
Fix warning ...
The docs plugin option homePageId=intro is deprecated. To make a doc the "home", prefer frontmatter: "slug: /"

Follow-up to #286.
 2020-10-21 13:52:25 +01:00
innovaker
99751ad376 chore(docs): Docusaurus 2.0.0-alpha.65 
Closes #286.  Prerequisite of #218.
 2020-10-21 13:51:58 +01:00
innovaker
a796ee574f fix(docs): Remove empty links 
Prerequisite fixes for Docusaurus 2.0.0-alpha.65 (#286) which has stricter markdown rules.
 2020-10-21 13:51:37 +01:00
Pete Johanson
ef37f17796
Merge pull request #109 from Nicell/underglow/state-persistence 
Add RGB underglow state Kconfig and settings
 2020-10-18 22:29:55 -04:00
Kellen Carey
4bd41b9bf9 add wget flag to example 2020-10-15 16:53:16 -07:00
Pete Johanson
a1387eb041
Merge pull request #250 from Tsquash/docs 
Added Feature Matrix for Intro.md
 2020-10-15 11:24:15 -04:00
Pete Johanson
548fa2a6eb
Merge pull request #277 from megamind4089/docs/ext-power 
Added docs for external power output
 2020-10-15 11:18:42 -04:00
Caleb Lightfoot
91b208faf3 Documented TX Power Config in Troubleshooting 2020-10-13 21:12:29 -05:00
Pete Johanson
b2cad7e597 fix(docs): Proper block for romac shield. 2020-10-13 19:50:24 -04:00
Pete Johanson
43c900f94a feat: Add qaz to setup scripts. 2020-10-13 19:46:02 -04:00
Mega Mind
cc21167d57 Added docs for external power output 2020-10-14 00:27:32 +08:00
Pete Johanson
b193e5b1bc
Merge pull request #265 from kurtis-lew/actuallyissue138 
Addressing #138 - ZMK Config Folders
 2020-10-13 00:29:37 -04:00
Pete Johanson
94bc2c31b1 feat: Add a couple missing shields to user setup. 2020-10-13 00:23:25 -04:00
Pete Johanson
47cfcb42d2
Merge pull request #257 from kurtis-lew/issue138 
Adressing Issue #181 - Split Keyboard Documentation
 2020-10-13 00:04:12 -04:00
Caleb Lightfoot
e475260664 Revert "Increased Comprehension of Oled Footnote" 
This reverts commit d4b83c3ebf.
 2020-10-12 19:06:40 -05:00
Caleb Lightfoot
d4b83c3ebf Increased Comprehension of Oled Footnote 2020-10-12 18:52:29 -05:00
Pete Johanson
d0c6310434
Merge pull request #259 from Tsquash/DFU 
Issue: #197 Added Setup Instructions for `dfu-util`
 2020-10-12 11:08:21 -04:00
Pete Johanson
0d893e5fd2
Merge pull request #260 from Tsquash/PSscript 
Issue #210 Document Setup.ps
 2020-10-12 10:50:31 -04:00
Caleb Lightfoot
1ef21c57ea added links to see progress of features. 2020-10-10 23:03:07 -05:00
Caleb Lightfoot
593d7ff781 made table completely visual; changed feature sentence 2020-10-10 22:40:14 -05:00
Tsquash
56ab812a67 fixed BLE part of table 2020-10-10 22:18:18 -05:00
Tsquash
229c8b4358 Added BlueMicro Collumn 2020-10-10 22:18:18 -05:00
Tsquash
21987d3385 update intro.md 2020-10-10 22:18:18 -05:00
Tsquash
d7bfe979c9 Fixed Footnote and added user config repo 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
eb9dc37f00 fix table 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
e2a845b2eb removed checkmark from zmk oled 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
93c5ae17ac Uniformed Capitals, Added footnotes 2020-10-10 22:18:18 -05:00
Caleb Lightfoot
910e207dbc Update Intro 
changed intro wording and link to layer tap
Update intro.md
 2020-10-10 22:18:18 -05:00
Tsquash
e740a83d68 Made columns wider 2020-10-10 22:17:52 -05:00
Tsquash
90b56a1941 added in dev 2020-10-10 22:17:52 -05:00
Tsquash
23e9cbcaf9 Added Table and fixed Feature sentence 
added feature table

new feature sentence
 2020-10-10 22:17:52 -05:00
kurtis-lew
677746014c Addressing #138 - ZMK Config Folders 2020-10-10 19:33:47 -07:00
Kellen Carey
b738cc9d75 add option to use wget 2020-10-10 19:16:07 -07:00
Kellen Carey
f9e8866a52 add support for wget to setup.sh 2020-10-10 18:28:16 -07:00
Pete Johanson
a7e8655287
Merge pull request #256 from careyk007/check_directory_write_permissions_in_setup_script 
Exit setup if no write permissions in directory
 2020-10-10 20:09:55 -04:00
Kellen Carey
4aa45c6f40
update setup.ps1 2020-10-10 17:00:13 -07:00
Tsquash
d79811dd61 Changed setup script url 2020-10-10 14:39:12 -05:00
Tsquash
45f4ffc03a added PowerShell setup Command 2020-10-10 13:03:34 -05:00
Tsquash
8d4e80c23a Added Dfu-Util to setup instructions 2020-10-10 11:10:17 -05:00
Kurtis Lew
fc6c01fd69
-DZMK_CONFIG Documentation (#255) 
feat(docs): `-DZMK_CONFIG` Documentation
 2020-10-09 23:56:52 -04:00
Idan Gazit
5401afc002
Skip toolchain for docker 2020-10-09 19:10:07 -07:00
Idan Gazit
5c00c97e9a
Wrap up documentation 2020-10-09 19:09:11 -07:00
Idan Gazit
15614a946f
WIP docs for docker development 2020-10-09 19:09:08 -07:00
Kellen Carey
b64517943d add powershell check 2020-10-09 18:53:21 -07:00
kurtis-lew
3322c3cab1 Adressing Issue #138 2020-10-09 18:51:51 -07:00
Kellen Carey
10029c297e exit setup if no write permissions in directory 2020-10-09 18:00:11 -07:00
Pete Johanson
405ca7267f
Merge pull request #254 from kurtis-lew/docissue220 
Documented Issue #220
 2020-10-09 16:02:25 -04:00
kurtis-lew
1f2bdf639f Adjusted Wording, Added link to GH Actions 2020-10-09 12:57:07 -07:00
Pete Johanson
81a4ffef7e feat(setup): Add Microdox to setup scripts. 2020-10-09 15:44:39 -04:00
Pete Johanson
e53320a687 fix(docs): Remove hanging footnote. 2020-10-09 11:57:34 -04:00
kurtis-lew
7128808bba Revert "Added -DZMK_CONFIG Documentation" 
This reverts commit a9ec1148e5.
 2020-10-09 08:19:50 -07:00
kurtis-lew
e03b51fe2e Revert "Addressing Issue #181" 
This reverts commit 49315c2f6d.
 2020-10-09 08:19:46 -07:00
kurtis-lew
429c9dc464 Revert "Addressed Issue #181" 
This reverts commit dbda99a378.
 2020-10-09 08:19:40 -07:00
kurtis-lew
aca801d90f Revert "Removed blank space" 
This reverts commit c27d3c66f1.
 2020-10-09 08:19:08 -07:00
kurtis-lew
a58a8412c7 Documented Issue #220 2020-10-09 08:15:38 -07:00
kurtis-lew
c27d3c66f1 Removed blank space 2020-10-08 22:21:49 -07:00
kurtis-lew
dbda99a378 Addressed Issue #181 2020-10-08 22:19:26 -07:00
kurtis-lew
49315c2f6d Addressing Issue #181 2020-10-08 22:18:53 -07:00
kurtis-lew
a9ec1148e5 Added -DZMK_CONFIG Documentation 2020-10-08 22:16:53 -07:00
Kevin
ea05df0290 docs: Added link to clarify where to add sensor-bindings code 2020-10-08 21:44:32 -07:00
Tyler Walker
a8d48b043d add benign uf2 transfer error for macOS to troubleshooting 2020-10-08 18:42:55 -04:00
Ben Huddleston
2300ce306a
Correct typo in previous profile behaviour binding in bluetooth.md 2020-10-07 22:25:21 +01:00
Pete Johanson
4de7cc45de feat(setup): Add M.2 and M60 to setup scripts. 2020-10-05 09:43:05 -04:00
Kevin
6427e64df3 fix(docs): Reorganized section in Windows setup 2020-10-04 17:10:34 -07:00
Kevin
31e481954f fix(docs): Fixed Python environment variables and commands for Windows setup 2020-10-04 17:03:56 -07:00
Pete Johanson
dfb4f1277d fix(docs): Proper emphasis of MUST NOT. 2020-10-02 23:17:53 -04:00
Pete Johanson
9a3d515583 fix(docs): Link to nice!nano product page itself. 2020-10-01 15:40:39 -04:00
Pete Johanson
819c82547d
Merge pull request #180 from CrossR/CrossR/ShellScriptTidyUp 
Shell script tidy up.
 2020-09-24 14:36:07 -04:00
Pete Johanson
d5ec32612d feat(docs): Add missing shields to hardware page. 2020-09-24 14:34:38 -04:00
CrossR
cd194dbac4 Add licenses. 2020-09-24 19:28:02 +01:00
Pete Johanson
a7ef79e3f8 feat(blog): SOTF #2 initial work.- Closes #182 2020-09-21 23:04:22 -04:00
CrossR
550c35db23 Fix PR comments, add error checking for push. 2020-09-20 12:52:25 +01:00
Pete Johanson
9b89ed7be4
Merge pull request #187 from kurtis-lew/main 
Fixed Iris default build/Updated Dev Guide
 2020-09-19 23:12:17 -04:00
Nick
18d21b0362 Merge remote-tracking branch 'upstream/main' into underglow/state-persistence 2020-09-15 14:41:59 -05:00
Kurtis Lew
ec86500524
Update dev-guide-new-shield.md 2020-09-14 20:53:26 -07:00
Kurtis Lew
0f8561daa1
Update dev-guide-new-shield.md 2020-09-14 20:46:42 -07:00
kurtis-lew
f6932992d2 Revert "Revert "Merge pull request #1 from zmkfirmware/main"" 
This reverts commit 5383bdd4df.
 2020-09-14 20:39:30 -07:00
kurtis-lew
5383bdd4df Revert "Merge pull request #1 from zmkfirmware/main" 
This reverts commit 36da21b8e3, reversing
changes made to 719db13c41.
 2020-09-14 20:38:58 -07:00
kurtis-lew
1a492f0f98 Updated dev guide 2020-09-14 20:37:26 -07:00
Pete Johanson
676288fef2
Merge pull request #159 from okke-formsma/docs-update 
update intro page, add layer-tap docs and update hold-tap docs.
 2020-09-14 10:14:15 -04:00
Pete Johanson
6c8b0b53f0 refactor(bluetooth): More concise names. 2020-09-13 22:33:31 -04:00
Pete Johanson
39f980a06d feat(bluetooth): Add back profiles, split fixes. 
* Add back in profiles, not using Zephyr
  BT identity infrastructure.
* Restore additional `&bt` commands for profile
  operations.
* Fix for split pairing and subscriptions, since
  Zephyr persists subscriptions across connects.
* Remove keymap from peripheral builds, reduces
  firmware size, and avoids unneeded attempts
  to send HID data.
 2020-09-13 22:33:29 -04:00
Pete Johanson
fc0812bd2e fix(bluetooth): Remove identity, minimal bt. 
* Simplify the `bt` behavior to one current command
  `BT_CLEAR_BONDS_CMD`.
* Simplify BLE code for split and non-split keyboards.
* Remove keymap processing from split peripheral side.
 2020-09-13 22:33:05 -04:00
Pete Johanson
cf970efb98 feat(bluetooth): Proper bond management, identity support for non-splits 
* Add `bt` behavior that can be used to perform certain actions,
  such as next/prev identity, reset identity, etc.
  NOTE: Multiple identities is only supported for non-split shields,
  due to missing Zephyr identity functionality for dual
  central/peripheral devices.
* Proper bond reset tied to action, that honors peripheral bonds,
  so folks can reset and pair to other hosts, without breaking
  bonds between splt halves.
 2020-09-13 22:33:05 -04:00
Okke Formsma
763d62f6f2 update intro page, add layer-tap docs and update hold-tap docs. 2020-09-13 21:17:56 +02:00
CrossR
595dff6871 Add PowerShell script and tidy up bash script. 2020-09-13 18:07:45 +01:00
Pete Johanson
304603240f
Merge pull request #173 from LowNightSnack/main 
Resolved #171
 2020-09-11 14:31:01 -04:00
Mamoor Jaan Khan
e11cad9fde
Update hold-tap.md 2020-09-11 23:49:12 +05:30
Mamoor Jaan Khan
ce8ade4afa
A bad commit 2020-09-11 23:48:53 +05:30
Mamoor Jaan Khan
54437db0ba
Update with the examples 2020-09-11 20:42:33 +05:30
Mamoor Jaan Khan
98bd4796cf
Reverting previous commit 2020-09-11 20:40:19 +05:30
Mamoor Jaan Khan
7f5235904a
Reverting previous commit 2020-09-11 20:37:57 +05:30
Mamoor Jaan Khan
178e5e5afb
Reverting provious commit 2020-09-11 20:37:05 +05:30
Mamoor Jaan Khan
6d7fb6c48d
Update dev-clean-room.md 2020-09-11 20:10:23 +05:30
Mamoor Jaan Khan
c20eb9abac
Update hold-tap.md 2020-09-11 20:01:46 +05:30
Mamoor Jaan Khan
4ce70831dd
Update dev-guide-new-shield.md 2020-09-11 19:54:03 +05:30
Mamoor Jaan Khan
e660e56dfb
Update dev-boards-shields-keymaps.md 2020-09-11 19:52:32 +05:30
Mamoor Jaan Khan
69e6a99180
Add files via upload 2020-09-11 19:49:46 +05:30
Mamoor Jaan Khan
ce862d148d
Delete pro-micro-labelled-image.jpg 2020-09-11 19:47:20 +05:30
Cody McGinnis
cd00c0aad4
fix(docs): Fix the example mod tap configuration 2020-09-11 02:28:55 -04:00
Mamoor Jaan Khan
89ba824b2b
typo 2020-09-11 11:04:58 +05:30
Pete Johanson
3f9bb3edab
Merge pull request #175 from kurtis-lew/troubleshooting 
Added File Transfer Error/CMake Warning Docs
 2020-09-11 00:02:36 -04:00
Kurtis Lew
5b38fcff71
Reversed pairing instructions 2020-09-10 18:44:39 -07:00
kurtis-lew
073f5c8b98 Added File Transfer Error/CMake Warning Docs 2020-09-10 18:40:07 -07:00
Mamoor Jaan Khan
92b3ea8a6b
Update dev-guide-new-shield.md 2020-09-10 10:04:15 +05:30
Mamoor Jaan Khan
3c9f58f9d4
Update dev-boards-shields-keymaps.md 2020-09-10 10:03:48 +05:30
Mamoor Jaan Khan
d02fc07c4f
Update dev-boards-shields-keymaps.md 2020-09-10 10:02:25 +05:30
Mamoor Jaan Khan
82ddf81fcb
Update dev-guide-new-shield.md 2020-09-10 09:59:33 +05:30
Mamoor Jaan Khan
6a0e85ea72
labelled image to be added 2020-09-10 09:54:22 +05:30
Pete Johanson
e796e7c3e6
Merge pull request #165 from kurtis-lew/troubleshooting 
Troubleshooting - Revised Copy of PR 150
 2020-09-09 23:15:21 -04:00
Alexander Elias
6456fab8e0
Should this be org instead of com? 2020-09-09 09:14:01 -07:00
Pete Johanson
df2da813f1 fix(docs): Remove broken Discord invite links. 2020-09-08 16:08:09 -04:00
Kurtis Lew
618c537be1
Updated Headers 2020-09-06 20:45:28 -07:00
kurtis-lew
336cae9d0f Adjusted lines to fix caption format 2020-09-06 20:13:45 -07:00
kurtis-lew
cb95b9f11a Restored Troubleshooting.md and associated files 2020-09-06 20:03:33 -07:00
kurtis-lew
bdeb6865e1 Update sidebars.js 2020-09-06 19:55:56 -07:00
Pete Johanson
61b249666b
Merge pull request #163 from bmcgavin/non-split-template 
Add RoMac / non-split template support
 2020-09-06 13:02:50 -04:00
Richard Jones
01da54aadf
point setup.sh at upstream 2020-09-06 17:54:45 +01:00
Pete Johanson
ba07fd1879
Merge pull request #154 from chenkevinh/docs/encoders 
Encoder documentation
 2020-09-06 12:23:11 -04:00
Richard Jones
80034c0078 Add RoMac / non-split template support 2020-09-06 15:51:12 +01:00
CrossR
df422e0205 Revert changes to Intro page. 2020-09-04 20:47:21 +01:00
CrossR
89d604b74b Clarify low power mode wording. 2020-09-04 19:31:04 +01:00
CrossR
0ede549a13 Fix Sofle build, update Intro page. 2020-09-03 22:54:06 +01:00
Pete Johanson
e559cb2d71 Add hold-tap to sidebar. 2020-09-03 10:14:16 -04:00
Kevin
e904a098b3 Added keymap update to encoder docs 2020-09-02 21:12:22 -07:00
Pete Johanson
c8f95dbaa8
Merge pull request #155 from kurtis-lew/iris 
Update setup.sh
 2020-09-03 00:05:06 -04:00
Kurtis Lew
f738fd7a67
Update setup.sh 2020-09-02 20:57:42 -07:00
kurtis-lew
9b1fd1323f Update setup.sh 2020-09-02 20:53:14 -07:00
Kevin
5eb50d7b18 Fixed links 2020-09-02 18:36:35 -07:00
Kevin
2629aa354f Removed old dev encoder page 2020-09-02 18:28:00 -07:00
Kevin
6f74e61dd3 Added user and dev encoder docs 2020-09-02 18:25:46 -07:00
Kevin
5b493ef334 Merge branch 'main' into docs/encoders 
Sync with upstream
 2020-09-02 17:37:39 -07:00
Pete Johanson
48a3729ffe
Merge pull request #146 from okke-formsma/hold-tap 
Hold-Tap implementation
 2020-09-02 13:55:26 -04:00
Okke Formsma
c9a82d71d0 fixes for feedback round 2 2020-09-02 16:41:39 +02:00
Okke Formsma
c5ca664411 some fixes based on feedback 2020-09-02 15:26:06 +02:00
Kevin
068626d1a7 Some work on encoder docs 2020-09-01 21:12:09 -07:00
Okke Formsma
29a23f0182 Add tap-hold docs, update mod-tap docs 2020-09-01 19:41:08 +02:00
CrossR
ca0f2bb074 Add to setup. 2020-09-01 18:32:45 +01:00
Kurtis Lew
96fde77560
Update key-press.md 
Specified keypress and consumer press pages
 2020-08-30 20:12:53 -07:00
Kevin Chen
45b1756a70
Replaced \ with / 
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
 2020-08-29 21:36:00 -07:00
Kevin
212dd91e29 PuTTY image fix 2020-08-29 21:27:03 -07:00
Kevin
06af711f57 Replaced png with jpg 2020-08-29 21:20:38 -07:00
Kevin
af23445aa0 COM image fix 2020-08-29 21:13:48 -07:00
Kevin
0e04596ef6 Renamed COM port image 2020-08-29 21:04:32 -07:00
Kevin
0a06760cda Updated alt text 2020-08-29 19:26:11 -07:00
Kevin
8594d832b6 Added split build directories 2020-08-29 19:23:25 -07:00
Kevin
bc13cd1de1 Added PuTTY to USB Logging 2020-08-29 19:22:43 -07:00
Kevin
037970fe8c Removed DKEYMAP and added split build directories 2020-08-29 18:43:13 -07:00
Kevin
276a2620b9 Minor capitalization fix 2020-08-29 17:47:41 -07:00
Kevin
dad2d339b3 Added customization page 2020-08-29 17:46:00 -07:00
Kevin
d7bd09149b Added info on connecting keyboard 2020-08-29 17:25:37 -07:00
Kevin
76095c64c6 Fixed title 2020-08-29 17:25:00 -07:00
Kevin
133166c392 Pictures for environment variables 2020-08-29 17:23:17 -07:00
Kevin
9b9174cc57 Added lily58 reset photo 2020-08-29 17:22:39 -07:00
Kevin
96020a469a Added win environment variables instructions 2020-08-29 17:21:56 -07:00
Kevin
35dc46bfbb Made separate build and flash page with updated content 2020-08-29 15:51:08 -07:00
Kevin
ec6215f38e Added Arduino IDE to USB Logging 2020-08-29 15:05:43 -07:00
Cody McGinnis
205a54baeb fix(docs): update the testing docs 2020-08-28 16:21:31 -04:00
Cody McGinnis
26414a6982 fix(docs): move testing docs to website docs 2020-08-28 16:21:31 -04:00
crd
0c255aee84 [docs] Add bzip to deps 2020-08-22 09:29:23 -07:00
Pete Johanson
760de7d3c6
Merge pull request #92 from Na-Cly/shields/splitreus62 
Add splitreus62 shield
 2020-08-21 22:37:50 -04:00
Pete Johanson
805ea77005 feat(behaviors): Add &bootloader behavior. 
* Allow reset behavior to have a type property.
* Add `bootloader` node that triggers DFU UF2
  bootloader mode using the AdaFruit nrf52
  bootloader.
 2020-08-21 11:23:45 -04:00
Pete Johanson
1ff13676f7 fix(docs): Better behavior sidebar label/titles. 2020-08-21 00:31:28 -04:00
Nick
bee5f7c350 fix(rgb): add missing Kconfig docs 2020-08-20 21:13:05 -05:00
Derek
94c7d27f04 Updated files as per request 
Updated
 2020-08-20 15:13:51 -04:00
Pete Johanson
11e3566277 fix(docs): Link to 2.3.0 docs, macOS toolchain fix 
* Link explicitly to the 2.3.0 docs from upstream
  Zephyr.
* Update the macOS toolchain section to properly
  refer to the 3rd party toolchain setup.
 2020-08-20 00:11:07 -04:00
Pete Johanson
3576738ab4
Merge pull request #103 from BrainWart/bond-clearing 
feat(docs): create a bond clearing page
 2020-08-19 21:02:03 -04:00
Pete Johanson
506c3b031e refactor(boards): Rename to bluemicro840_v1. 2020-08-19 16:35:18 -04:00
Cody McGinnis
02f541969c fix(docs): make time to clear explicit 2020-08-19 00:11:44 -04:00
Cody McGinnis
feadfc93dc feat(docs): create a bond clearing page 2020-08-19 00:07:08 -04:00
Pete Johanson
d2d9fc86cf feat(docs): Basic mod-tap behavior docs. 2020-08-18 15:24:38 -04:00
Pete Johanson
c054feb3c9
Merge pull request #100 from petejohanson/behaviors/add-none 
Add `&none` behavior.
 2020-08-18 14:31:20 -04:00
Pete Johanson
63e02d60dc feat(behaviors): Add &none behavior 2020-08-18 14:28:11 -04:00
Pete Johanson
c667be1404
Merge pull request #98 from BrainWart/layer-toggle 
Feature: Layer toggle
 2020-08-18 14:25:03 -04:00
Pete Johanson
2ffe09b617 fix(docs): Fix typo in key press behavior doc. 2020-08-18 14:11:48 -04:00
Cody McGinnis
bb4f45a57a fix(docs): add another example to toggle layer 2020-08-18 14:02:25 -04:00
Cody McGinnis
ae104374c0 feat(docs): document the toggle layer behavior 2020-08-18 14:02:24 -04:00
Pete Johanson
1607656c53 Note the fixed showstoppers. 2020-08-16 23:16:50 -04:00
Pete Johanson
3f1dfbaad1
Merge pull request #91 from Na-Cly/boards/bluemicro52840_v1 
Add bluemicro support
 2020-08-16 22:32:04 -04:00
Pete Johanson
abe40f8ef5 Various fixes. 2020-08-16 21:30:45 -04:00
Derek
17c43881b8 Updated select block 2020-08-16 13:43:59 -04:00
Derek
5bb01c802b Update setup.sh 2020-08-16 08:49:17 -04:00
Derek
e554cbcbc3 Merge branch 'boards/bluemicro52840_v1' of https://github.com/Na-Cly/zmk into boards/bluemicro52840_v1 2020-08-16 08:45:22 -04:00
Derek
68da92f4dd Update setup.sh 2020-08-16 08:45:03 -04:00
Derek
ba1cde94a8
Update docs/static/setup.sh 
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
 2020-08-16 08:43:09 -04:00
Pete Johanson
94549b4a07
Merge pull request #89 from Nicell/underglow/fix-configs 
Add missing configuration values for RGB underglow
 2020-08-15 21:17:14 -04:00
Pete Johanson
ee5900686b Fix the active/pull down flags for the example. 2020-08-15 21:13:50 -04:00
Pete Johanson
7e1942867b Doc fixes for keymaps. 2020-08-15 20:20:19 -04:00
Derek
23b188330f Update setup.sh 
Updated setup.sh
 2020-08-15 19:30:35 -04:00
Nick
2863f15006 Fix docs typos 2020-08-14 21:36:11 -05:00
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