https://github.com/zzkt/zczen

📟 yet another crkbd (zmk/zen) keymap (emacs centric)
https://github.com/zzkt/zczen

corneish-zen crkbd emacs keyboard-layout zmk

Last synced: about 1 month ago
JSON representation

📟 yet another crkbd (zmk/zen) keymap (emacs centric)

• Host: GitHub
• URL: https://github.com/zzkt/zczen
• Owner: zzkt
• Created: 2024-07-08T15:02:48.000Z (6 months ago)
• Default Branch: endless
• Last Pushed: 2024-07-08T17:41:48.000Z (6 months ago)
• Last Synced: 2024-10-13T22:43:59.895Z (2 months ago)
• Topics: corneish-zen, crkbd, emacs, keyboard-layout, zmk
• Homepage:
• Size: 603 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Corne-ish Zen V2 Custom Configuration

![Corne-ish Zen Logo](img/zczen.jpg)

## Resources

- The [official ZMK Firmware GitHub](https://github.com/zmkfirmware/zmk) repository. View the keymaps for other boards and shields as a starting point for your keymap.

- The [official ZMK Documentation](https://zmk.dev/docs) web site. Find the answers to many of your questions about ZMK Firmware.

- The [official ZMK Discord Server](https://zmk.dev/community/discord/invite). Instant conversations with other ZMK developers and users. Great technical resource!

- [Corne-ish Zen Support](https://lowprokb.ca/pages/corne-ish-zen-support)

## 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](https://docs.github.com/en/get-started/quickstart/fork-a-repo))

3. Edit the keymap file(s) to suit your needs:

    - Change [the keymap file](/config/corneish_zen.keymap) to edit keycodes, add new layers etc.

    - Change [the conf file](/config/corneish_zen.conf) to edit configuration settings like changing the deep sleep timeout

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.

> **Note**

> 

> After forking the repo to your own account, you can also edit the files directly using the GitHub web interface via the edit button on the top right (keyboard shortcut `e`) or via the [GitHub Dev](https://github.com/github/dev) interface (keyboard shortcut `.`) and commit your changes.

## 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.

    - If you only changed [the keymap file](/config/corneish_zen.keymap) you only need to flash the left side firmware to the left side.

    - If you changed [the conf file](/config/corneish_zen.conf) you should flash both sides their respective files.

Your keyboard is now ready to use.