gwg313/zmk-configs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add badges to readme
Some checks failed
ci/woodpecker/manual/woodpecker/3 Pipeline failed
Details
ci/woodpecker/manual/woodpecker/5 Pipeline failed
Details
ci/woodpecker/manual/woodpecker/2 Pipeline failed
Details
ci/woodpecker/manual/woodpecker/1 Pipeline failed
Details
ci/woodpecker/manual/woodpecker/4 Pipeline failed
Details
ci/woodpecker/manual/woodpecker/6 Pipeline failed
Details
ci/woodpecker/manual/woodpecker/8 Pipeline failed
Details
ci/woodpecker/manual/woodpecker/7 Pipeline failed
Details

Browse source 
Signed-off-by: gwg313 <gwg313@pm.me>
This commit is contained in:
gwg313 2025-06-30 15:30:12 -04:00
parent 03c030339f
commit dede0aac6f
Signed by: gwg313
GPG key ID: 60FF63B4826B7400
4 changed files with 14 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,34 +1,37 @@
# ZMK Personal Configurations
Welcome to my personal ZMK configurations!
## Build Status and Results
[![Woodpecker CI](https://ci.gwg313.xyz/api/badges/gwg313/zmk-configs/status.svg)](https://ci.gwg313.xyz/gwg313/zmk-configs)
[![Firmware Builds](https://img.shields.io/badge/downloads-firmware-blue)](https://s3-console.gwg313.xyz/browser/zmk-builds)
## Introduction
These are my custom ZMK configurations for my keyboard setup. Feel free to explore and adapt them to suit your needs.
These are the configurations for my custom keyboard layouts.
## Getting Started
### Prerequisites
This repository leverages GitHub Actions to automatically build the firmware files. You can find the artifacts in the Actions tab of this repository. All you need is your text editor of choice to make changes.
## Configuring Your Keyboard
### Keymap
Adjust the relevant keymap configuration in `config/*.keymap` to define the function of each key on your keyboard.
Adjust the relevant keymap configuration in `config/*.keymap` to define the
function of each key on your keyboard.
You can find my daily keymap [here](config/base_lower.keymap)
## Automated Build and Flash
The firmware is automatically built using GitHub Actions. Once built, it is uploaded as an artifact. No manual building is required.
The firmware is automatically built using GitHub Actions. Once built, it is
uploaded as an artifact. No manual building is required.
To flash them connect a compatable keyboard and enter bootloader mode, then drag and drop the relevant uf2 files.
To flash them connect a compatable keyboard and enter bootloader mode, then drag
and drop the relevant uf2 files.
## Support
For more information you can view the ZMK docs [here](https://zmk.dev/docs/development/documentation)
For more information you can view the ZMK docs
[here](https://zmk.dev/docs/development/documentation)
If you have any questions or need assistance, feel free to reach out.