Jacob/zmk
1
0
Fork 0
forked from kofal.net/zmk
Code Pull Requests Activity

Added customization page

Browse Source
This commit is contained in:
Kevin
2020-08-29 17:46:00 -07:00
parent d7bd09149b
commit dad2d339b3
6 changed files with 37 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docs/user-setup.md
View File

@@ -184,27 +184,3 @@ Connecting your keyboard wirelessly is the same as adding other Bluetooth devide
### Connecting Split Keyboard Halves
For split keyboards, after flashing each half individually you can connect them together by resetting them at the same time. Within a few seconds of resetting, both halves should automatically connect to each other.
## Customization
### Configuration Changes
The setup script creates a `config/<shield>.conf` file that allows you to add additional configuration options to
control what features and options are built into your firmware. Opening that file with your text editor you should see
various config settings that can be commented/uncommented to modify how your firmware is built.
### Keymap
Once you have the basic user config completed, you can find the file in `config/<shield>.keymap` and customize from there.
Refer to the [Keymap](/docs/feature/keymaps) documentation to learn more.
### Publishing
After making any changes you want, you should commit the changes and then push them to GitHub. That will trigger a new
GitHub Actions job to build your firmware which you can download once it completes.
:::note
If you need to, a review of [Learn The Basics Of Git In Under 10 Minutes](https://www.freecodecamp.org/news/learn-the-basics-of-git-in-under-10-minutes-da548267cc91/) will help you get these steps right.
:::
For split keyboards, only the central (usually left) side will need to be reflashed after making updates to your keymap.