https://github.com/zored/zkf
JavaScript-compiled QMK firmwares
https://github.com/zored/zkf
Last synced: 1 day ago
JSON representation
JavaScript-compiled QMK firmwares
- Host: GitHub
- URL: https://github.com/zored/zkf
- Owner: zored
- Created: 2019-03-31T09:38:34.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-07T21:35:45.000Z (over 2 years ago)
- Last Synced: 2025-01-13T10:50:45.334Z (over 1 year ago)
- Language: C
- Homepage:
- Size: 423 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/zored/zkf)
# ZKF
Zored Keyboard Firmwares — are [simply configured](config.yaml) keyboard firmwares based on [QMK](https://github.com/qmk/qmk_firmware).
[Github page is here](https://zored.github.io/zkf/).
I have:
- [Ergodox](https://ergodox-ez.com).
- [Planck](https://ergodox-ez.com/pages/planck).
- [YMD09](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ymdk/ymd09).
- [DAO44](https://github.com/yumagulovrn/dao-choc-ble) (based on [ZMK framework fork](https://github.com/zored/dao-zmk-config/tree/zored)).
Supports Windows and macOS.
## Example
```bash
./project.sh build-and-flash planck
```
### How it works
- [YAML file](config.yaml) is a readable config.
- JavaScript code [compiles](compiler/README.md) config into keymap files.
- QMK (with [my patches](patches/)) builds firmware.
- Teensy flashes firmware into keyboard.
## Additional info
- To make Russian layout on MacOS smae with Windows run `./project.sh provision` and choose `Русская BG46` as Russian input source.