summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortjcampie <tjcampie@zmk.local>2020-08-21 06:37:04 -0500
committertjcampie <tjcampie@zmk.local>2020-08-21 06:37:04 -0500
commit6b23c7f554dbb27794cda5bff42545b1532b02c8 (patch)
tree095a1c5189f690baa07e839d1cc7ec8c2d958235
parent5b76179bf6db93717cde0c4da39b5421a0c5bad3 (diff)
parent1ff13676f7fbab5c0d69317be0d186709a7872c8 (diff)
Merge branch 'main' of https://github.com/zmkfirmware/zmk into main
-rw-r--r--.github/workflows/build.yml2
-rw-r--r--app/Kconfig4
-rw-r--r--app/cmake/zmk_config.cmake1
-rw-r--r--docs/docs/behavior/key-press.md3
-rw-r--r--docs/docs/behavior/layers.md8
-rw-r--r--docs/docs/behavior/lighting.md11
-rw-r--r--docs/docs/behavior/misc.md3
-rw-r--r--docs/docs/behavior/mod-tap.md3
8 files changed, 24 insertions, 11 deletions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 0f0e74a..5086bf8 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -25,6 +25,8 @@ jobs:
- name: Checkout
uses: actions/checkout@v2
- name: Cache west modules
+ timeout-minutes: 2
+ continue-on-error: true
uses: actions/cache@v2
env:
cache-name: cache-zephyr-modules
diff --git a/app/Kconfig b/app/Kconfig
index 00d4ae3..877fce4 100644
--- a/app/Kconfig
+++ b/app/Kconfig
@@ -193,6 +193,10 @@ source "subsys/logging/Kconfig.template.log_config"
rsource "boards/Kconfig"
rsource "boards/shields/*/Kconfig.defconfig"
+rsource "boards/shields/*/Kconfig.shield"
+
+osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.defconfig"
+osource "$(ZMK_CONFIG)/boards/shields/*/Kconfig.shield"
source "Kconfig.zephyr"
diff --git a/app/cmake/zmk_config.cmake b/app/cmake/zmk_config.cmake
index 518c3c3..017dd11 100644
--- a/app/cmake/zmk_config.cmake
+++ b/app/cmake/zmk_config.cmake
@@ -44,6 +44,7 @@ endif()
set(CACHED_ZMK_CONFIG ${ZMK_CONFIG} CACHE STRING "Selected user ZMK config")
if (ZMK_CONFIG)
+ set(ENV{ZMK_CONFIG} "${ZMK_CONFIG}")
if(EXISTS ${ZMK_CONFIG}/boards)
message(STATUS "Adding ZMK config directory as board root: ${ZMK_CONFIG}")
list(APPEND BOARD_ROOT ${ZMK_CONFIG})
diff --git a/docs/docs/behavior/key-press.md b/docs/docs/behavior/key-press.md
index 1ae7e31..2edce1d 100644
--- a/docs/docs/behavior/key-press.md
+++ b/docs/docs/behavior/key-press.md
@@ -1,5 +1,6 @@
---
-title: Key Presses
+title: Key Press Behaviors
+sidebar_label: Key Press
---
## Summary
diff --git a/docs/docs/behavior/layers.md b/docs/docs/behavior/layers.md
index 3e520ca..da7f07f 100644
--- a/docs/docs/behavior/layers.md
+++ b/docs/docs/behavior/layers.md
@@ -1,5 +1,6 @@
---
-title: Layers
+title: Layer Behaviors
+sidebar_label: Layers
---
## Summary
@@ -56,12 +57,13 @@ Example:
```
"Toggle layer" for a :
+
```
#define DEFAULT 0
#define NAVI 1
#define NONE 0
-
+
/ {
keymap {
compatible = "zmk,keymap";
@@ -89,4 +91,4 @@ Example:
};
```
-It is possible to use "toggle layer" to have keys that raise and lower the layers as well. \ No newline at end of file
+It is possible to use "toggle layer" to have keys that raise and lower the layers as well.
diff --git a/docs/docs/behavior/lighting.md b/docs/docs/behavior/lighting.md
index 432960e..2d4f532 100644
--- a/docs/docs/behavior/lighting.md
+++ b/docs/docs/behavior/lighting.md
@@ -1,15 +1,16 @@
---
-title: Lighting
+title: Lighting Behavior
+sidebar_label: Lighting
---
## Summary
-Lighting is often used for either aesthetics or for the practical purposes of lighting up keys in the dark.
+Lighting is often used for either aesthetics or for the practical purposes of lighting up keys in the dark.
Currently ZMK supports RGB underglow, which can be changed and configured using its behavior.
## RGB Action Defines
-RGB actions defines are provided through the [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h) header,
+RGB actions defines are provided through the [`dt-bindings/zmk/rgb.h`](https://github.com/zmkfirmware/zmk/blob/main/app/include/dt-bindings/zmk/rgb.h) header,
which is added at the top of the keymap file:
```
@@ -21,7 +22,7 @@ This will allow you to reference the actions defined in this header such as `RGB
Here is a table describing the action for each define:
| Define | Action |
-|-----------|-----------------------------------------------------------|
+| --------- | --------------------------------------------------------- |
| `RGB_TOG` | Toggles the RGB feature on and off |
| `RGB_HUI` | Increases the hue of the RGB feature |
| `RGB_HUD` | Decreases the hue of the RGB feature |
@@ -47,4 +48,4 @@ Example:
```
&rgb_ug RGB_TOG
-``` \ No newline at end of file
+```
diff --git a/docs/docs/behavior/misc.md b/docs/docs/behavior/misc.md
index 799c91c..446ba33 100644
--- a/docs/docs/behavior/misc.md
+++ b/docs/docs/behavior/misc.md
@@ -1,5 +1,6 @@
---
-title: Miscellaneous
+title: Miscellaneous Behaviors
+sidebar_label: Miscellaneous
---
## Summary
diff --git a/docs/docs/behavior/mod-tap.md b/docs/docs/behavior/mod-tap.md
index cae667e..08e9b65 100644
--- a/docs/docs/behavior/mod-tap.md
+++ b/docs/docs/behavior/mod-tap.md
@@ -1,5 +1,6 @@
---
-title: Mod-Tap
+title: Mod-Tap Behavior
+sidebar_label: Mod-Tap
---
## Summary