Skip to content

Commit a8e8470

Browse files
authored
Add first README version
1 parent 8b037ec commit a8e8470

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# ZMK Config
2+
3+
My custom ZMK layout for Crone v4 — inspired by miryuko. Built and maintained by me.
4+
🔧 Designed using [Nick Coutso’s Keymap Editor](https://nickcoutsos.github.io/keymap-editor/)
5+
6+
## 🎯 Badges
7+
8+
[![GitHub Repo stars](https://img.shields.io/github/stars/bentocoding/zmk-config?style=social)](https://github.com/bentocoding/zmk-config/stargazers)
9+
[![GitHub forks](https://img.shields.io/github/forks/bentocoding/zmk-config?style=social)](https://github.com/bentocoding/zmk-config/network/members)
10+
[![GitHub watchers](https://img.shields.io/github/watchers/bentocoding/zmk-config?style=social)](https://github.com/bentocoding/zmk-config/watchers)
11+
12+
## 📊 Stats
13+
- **Languages**: C (97.7%), CMake (2.3%)
14+
15+
## 🖼️ Keymap Layers
16+
17+
### 🅰️ Alphabet Layer
18+
![Alphabet Layer](IMAGE_URL)
19+
20+
### 🔢 Numbers Layer
21+
![Numbers Layer](IMAGE_URL)
22+
23+
### ⚙️ Symbols Layer
24+
![Symbols Layer](IMAGE_URL)
25+
26+
### 🎛️ Functions Layer
27+
![Functions Layer](IMAGE_URL)
28+
29+
## 📁 Structure
30+
- `config/` - Main configuration files
31+
- `boards/` - Board-specific settings
32+
- `.github/workflows/` - CI/CD automation
33+
34+
## 🛠️ Setup
35+
1. Clone the repo
36+
2. Install ZMK dependencies
37+
3. Build & flash your firmware
38+
39+
## 🤝 Contributing
40+
Feel free to open issues or pull requests!
41+
42+
## 📄 License
43+
MIT

0 commit comments

Comments
 (0)