- You will need to sign up for a GitHub account, and fork this repository so you can edit it.
- Navigate to the Actions tab and click the "I understand my workflows, go ahead and run them" button to enable builds.
- Edit config/uwu30.conf to add/enable/disable features. Edit config/uwu30.keymap to change the keymap.
- After committing your changes, your firmware will begin compiling. Assuming there are no typos or other problems, it will eventually be downloadable from the Actions tab.
- Flash the non-settings-reset firmware.
You can add this repository as a module by modifying your config/west.yml
file.
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
# Add the base GitHub URL as a remote.
- name: ojthetiny # You can name this whatever you like; just make sure the "remote" below matches.
url-base: https://github.com/ojthetiny
projects:
- name: zmk
remote: zmkfirmware
revision: main
import: app/west.yml
# Add the name of the repository as a project.
- name: zmk-config
remote: ojthetiny
revision: master # This is the name of the branch you want to use.
self:
path: config
After making this change, add a copy of the configuration file and the keymap to the config
folder that is already in your repo.
Carefully double-check the last changes you made. Each ZMK code is generally preceded by a reference categorizing what that code does. For example: the letter "Z" is categorized as a key press. To add the letter "Z" to a keymap, it must be written &kp Z
. Don't forget to read the ZMK docs!
Clicking into the details of the action will show the error log. While very long, this log will often show the exact line number causing the problem in your keymap so it is worth reading closely.
nickcoutsos's in-browser keymap editor aims to provide a GUI for remapping, which may be helpful.
Make sure you are editing the files in the config folder.
Changes made in the boards/arm
folder will be overridden or ignored; your customizations belong in config.
If you don't remember which profile on the keyboard was used, you may have to clear them all. See ZMK's documentation for more details on profile management.
As a last resort, try flashing the settings_reset
firmware; this will force-clear everything.
- ZMK's troubleshooting page
- Ask the ZMK experts in ZMK's Discord
- Stop by the CBKBD Discord