diff options
| author | Pete Johanson <peter@peterjohanson.com> | 2020-09-19 23:12:17 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-19 23:12:17 -0400 |
| commit | 9b89ed7be4c1277ef1d0694da93cb6174ab70647 (patch) | |
| tree | 3420688d3c7af7226664afaccf57d8c1475d09cf | |
| parent | c0806d27f1d048db335ecc854eab61b59e23ea7a (diff) | |
| parent | ec86500524239500552e0105a86dd62872b99fd7 (diff) | |
Merge pull request #187 from kurtis-lew/main
Fixed Iris default build/Updated Dev Guide
| -rw-r--r-- | .github/workflows/build.yml | 2 | ||||
| -rw-r--r-- | app/boards/shields/iris/iris.keymap | 7 | ||||
| -rw-r--r-- | docs/docs/dev-guide-new-shield.md | 34 |
3 files changed, 41 insertions, 2 deletions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 02657c0..4a43f5d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -16,6 +16,8 @@ jobs: - kyria_right - lily58_left - lily58_right + - iris_left + - iris_right - romac - settings_reset include: diff --git a/app/boards/shields/iris/iris.keymap b/app/boards/shields/iris/iris.keymap index 3bd74ed..6042ad7 100644 --- a/app/boards/shields/iris/iris.keymap +++ b/app/boards/shields/iris/iris.keymap @@ -1,5 +1,8 @@ -# Copyright (c) 2020 Pete Johanson, Kurtis Lew -# SPDX-License-Identifier: MIT +/* + * Copyright (c) 2020 Pete Johanson, Kurtis Lew + * + * SPDX-License-Identifier: MIT + */ #include <behaviors.dtsi> #include <dt-bindings/zmk/keys.h> diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/dev-guide-new-shield.md index 6140b07..01aad30 100644 --- a/docs/docs/dev-guide-new-shield.md +++ b/docs/docs/dev-guide-new-shield.md @@ -17,6 +17,7 @@ The high level steps are: - (Optional) Add the matrix transform for mapping KSCAN row/column values to sane key positions. This is needed for non-rectangular keyboards, or where the underlying row/column pin arrangement does not map one to one with logical locations on the keyboard. - Add a default keymap, which users can override in their own configs as needed. - Add support for features such as encoders, OLED displays, or RGB underglow. +- Update build.yml It may be helpful to review the upstream [shields documentation](https://docs.zephyrproject.org/2.3.0/guides/porting/shields.html#shields) to get a proper understanding of the underlying system before continuing. @@ -302,3 +303,36 @@ and then flash with: ``` west flash ``` + +## Updating `build.yml` + +Before publishing your shield to the public via a PR, navigate to `build.yml` found in `.github/workflows` and add your shield to the appropriate list. An example edit to `build.yml` is shown below. + +``` +jobs: + build: + runs-on: ubuntu-latest + name: Build Test + strategy: + matrix: + board: [proton_c, nice_nano, bluemicro840_v1, nrfmicro_13] + shield: + - corne_left + - corne_right + - kyria_left + - kyria_right + - lily58_left + - lily58_right + - iris_left + - iris_right + - romac + - <MY_BOARD> + - <MY_SPLIT_BOARD_left> + - <MY_SPLIT_BOARD_right> + include: + - board: proton_c + shield: clueboard_california +``` +:::note +Notice that both the left and right halves of a split board need to be added to the list of shields for proper error checking. +:::note |