https://github.com/dbalatero/keyboard-config
A lightweight repo (you can fork) to manage your QMK configs, and compile/flash your keyboard.
https://github.com/dbalatero/keyboard-config
bash qmk qmk-config qmk-firmware qmk-keymap
Last synced: about 1 month ago
JSON representation
A lightweight repo (you can fork) to manage your QMK configs, and compile/flash your keyboard.
- Host: GitHub
- URL: https://github.com/dbalatero/keyboard-config
- Owner: dbalatero
- License: mit
- Created: 2020-08-23T16:40:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-13T03:57:06.000Z (over 2 years ago)
- Last Synced: 2025-03-23T22:13:29.088Z (over 1 year ago)
- Topics: bash, qmk, qmk-config, qmk-firmware, qmk-keymap
- Language: C
- Homepage:
- Size: 56.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# keyboard-config
This is a thin layer on top of the `qmk_firmware` repo. QMK encourages modifying their repo with your own keymaps, which is pretty heavy and dumb. This repo lets you define your own keymaps separately from QMK's firmware, and the provided `./qmk` script will take care of symlinking your custom keymaps into `qmk_firmware` so that they still build correctly.
## Setup
Run `./qmk setup` after cloning the repo. Answer `Y` (yes) to all the prompts.
It will clone a local copy of `qmk_firmware` into this repo.
You can update `qmk_firmware` at any time by `cd`ing to the directory and running `git pull.`
## Adding a new keymap
If you want to add a new keymap for a new keyboard:
1. Find the name of it, e.g. `handwired/dactyl_manuform/5x7` (you can look in `qmk_firmware/keyboards`)
2. `./qmk clone handwired/dactyl_manuform/5x7 dactyl_5x7`
You should now have a `dactyl_5x7` directory.
## Compiling and flashing your keymap
After editing the keymap you cloned with `./qmk clone`, compile your `.hex` file:
```
# replace "dactyl_5x7" with your map directory
$ ./qmk compile dactyl_5x7
```
To flash it onto your keyboard, plug it in and run:
```
$ ./qmk flash dactyl_5x7
```