kofal.net/zmk
1
0
Fork 1
mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-20 04:55:20 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add documentation for config options

Browse Source
This commit is contained in:
Joel Spadin
2021-03-06 20:06:15 -06:00
committed by Dom H
parent 6180643581
commit 11861a4d30
14 changed files with 1014 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/customization.md
View File

@@ -9,10 +9,10 @@ with the main `zmk` firmware repository to build your desired firmware. The main
working components of ZMK are kept separate from your personal keyboard settings, reducing the amount of file manipulation in the configuration process.
This makes flashing ZMK to your keyboard much easier, especially because you don't need to keep an up-to-date copy of zmk on your computer at all times.
On default `zmk-config` folder should contain two files:
By default, the `zmk-config` folder should contain two files:
- `<shield>.conf`
- `<shield>`.keymap
- `<shield>.keymap`
However, your config folder can also be modified to include a `boards/` directory for keymaps and configurations for multiple boards/shields
outside of the default keyboard setting definitions.
@@ -23,6 +23,8 @@ The setup script creates a `config/<shield>.conf` file that allows you to add ad
control what features and options are built into your firmware. Opening that file with your text editor will allow you to see the
various config settings that can be commented/uncommented to modify how your firmware is built.
Refer to the [Configuration](/docs/config/index) documentation for more details on this file.
## Keymap
Once you have the basic user config completed, you can find the keymap file in `config/<shield>.keymap` and customize from there.