Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 2.87 KB

README.md

File metadata and controls

31 lines (23 loc) · 2.87 KB
Raw

Corne-ish Zen Custom Configuration

Corne-ish Zen Logo

This repo is the official configuration of the Corne-ish Zen low profile wireless mechanical keyboard. Use it to develop your own keymap and easily build your own ZMK firmware to run on your Corne-ish Zen. These steps will get you using your keymap on your keyboard in the fastest time possible. It uses the GitHub Actions feature to build your firmware online, rather than setting up a complex tool chain on your local computer. If you are looking to dig deeper into ZMK and develop new functionality, it is recommended to follow the steps of installing ZMK as found on the official ZMK documentation site (linked below).

Note: This process is temporary, and will be used until such time that the Corne-ish Zen board definition is merged into ZMK Main.

Resources

Instructions

  1. Log into, or sign up for, your personal GitHub account.
  2. Fork this repository to your local computer, and then push it to your GitHub personal account. (instructions)
  3. Edit the keymap file(s) to suit your needs
  4. Commit and push your changes to your personal repo. Upon pushing it, GitHub Actions will start building a new version of your firmware with the updated keymap.

Firmware Files

To locate your firmware files...

  1. log into GitHub and navigate to your personal config repository you just uploaded your keymap changes to.
  2. Click "Actions" in the main navigation, and in the left navigation click the "Build" link.
  3. Select the desired workflow run in the centre area of the page (based on date and time of the build you wish to use). You can also start a new build from this page by clicking the "Run workflow" button.
  4. After clicking the desired workflow run, you should be presented with a section at the bottom of the page called "Artifacts". This section contains the results of your build, in a file called "firmware.zip"
  5. Download the firmware zip archive and extract the two .uf2 files. They are named according to which side they need to be flashed to.
  6. Flash the firmware to your keyboard by double-clicking the reset button to put the it in bootloader mode. A window should pop up showing the contents of the storage on the keyboard. Drag and drop the correct .uf2 file into the window. When the upload is complete the window will close and the keyboard will exit bootloader mode.

Your keyboard is now ready to use.