Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 2.22 KB

README.md

File metadata and controls

53 lines (39 loc) · 2.22 KB
Raw

Hillside ZMK firmware

hillside Build

This is the ZMK firmware for the Hillside family of split ergonomic keyboards.

It contains keymap definition files for three boards in ./config:

  • Hillside 52 with 3x6+3+5 keys
  • Hillside 48 with 3x6+1+5 keys
  • Hillside 46 with 3x6+5 keys

Pushing changes will build all the keyboards. You need to be signed in to a GitHub account to push changes and build the firmware. To not waste build time, comment out the keyboards in ./build.yaml that you do not have.

To build the firmware:

  • Fork this repo on GitHub
  • Clone your fork locally
  • Trigger a build:
    • Make a trivial change to ./build.yaml (or any non *.md file)
    • Push that change
  • Look in the Actions tab for the build triggered by that change.
  • Wait for the build to finish
  • Click on the build link next to the green checkbox
  • Download the artifact file with the firmware
  • See Installing The Firmware for more details from there.

Once your board works with the default firmware, you can modify the keymap. Your copies of the default Hillside keymaps are in:

Modify those as needed. Pushing the change will trigger a build as above.

If you want to enable features, modify the appropriate ./config/hillside*.conf file.

To add RGB support, uncomment the lines in the ./config/hillside*.conf file and add the &rgb_ug RGB_TOG and other keycodes to the keymap adjust layer. While RGB is disabled, any RGB control keys behave as transparent keys and activate keys on lower layers, which can be confusing.

The Hillside shield definition files should not need to be modified and are in ./config/boards/shields.

More information about each keymap is in their readme files.