Git Product home page Git Product logo

zmk-config-chalice's Introduction

ZMK Config

This repo stores keymaps for my keyboards running on ZMK.

It enables building custom keymaps without having to go through the process of installing the ZMK / Zephyr toolchain which can be quite painful.

To Use

  • Fork this repo
  • In your fork, click on the "actions" tab and enable GitHub actions
  • Clone the repo to your machine
  • Checkout the branch which you want to build, see below for options git checkout <branch>
  • Edit the keymap to customise as required, and save once done
  • Add the modified file to git git add .
  • Commit the changes git commit -m "update keymap"
  • Push the changes git push
  • With the above done, head to your fork, select actions, and click on the latest build run. When it finishes, there will be an artifact called "firmware" you can download.

Available Keymaps / Branches

Chalice

  • chalice_nn2_default Suggested layout for Chalice, running on a nice!nano v2
  • chalice_nn_default Suggested layout for Chalice, running on a nice!nano
  • chalice_nn2_splitbs Suggested split backspace layout for Chalice, running on a nice!nano v2
  • chalice_nn2_josh A Colemak layout with dedicated function and RGB layers, built for a n!n v2
  • chalice_nn_josh A Colemak layout with dedicated function and RGB layers, built for a n!n

Entropy

  • entropy_josh Colemak layout with split spacebar, numpad, and encoder support.

Making your own keymap / branch

  • First checkout the most similar branch to what you want (e.g. n!n or n!n v2, QWERTY vs Colemak) git checkout <branch>
  • Create a new branch based on currently checked out branch git checkout -b <your-branch-name>
  • Then follow the above instructions to modify and commit / push your changes to GitHub, where the keymap will then be built.

zmk-config-chalice's People

Contributors

customkbd avatar joshajohnson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.