kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor(docs): Remove local build section in customization

Browse source
This commit is contained in:
Cem Aksoylar 2023-11-10 22:22:05 -08:00 • committed by Pete Johanson
parent 2554b5c88f
commit a5c3edd51b
1 changed files with 9 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/docs/customization.md
View file

@ -11,15 +11,15 @@ This makes flashing ZMK to your keyboard much easier, especially because you don
By default, the `zmk-config` folder should contain two files:
- `<shield>.conf`
- `<shield>.keymap`
- `<keyboard>.conf`
- `<keyboard>.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.
## Configuration Changes
The setup script creates a `config/<shield>.conf` file that allows you to add additional configuration options to
The setup script creates a `config/<keyboard>.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 will allow you to see the
various config settings that can be commented/uncommented to modify how your firmware is built.
@ -27,7 +27,7 @@ Refer to the [Configuration](/docs/config) documentation for more details on thi
## Keymap
Once you have the basic user config completed, you can find the keymap file in `config/<shield>.keymap` and customize from there.
Once you have the basic user config completed, you can find the keymap file in `config/<keyboard>.keymap` and customize from there.
Refer to the [Keymap](features/keymaps.md) documentation to learn more.
## Publishing
@ -39,18 +39,11 @@ GitHub Actions job to build your firmware which you can download once it complet
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.
:::
## Building from a local `zmk` fork using `zmk-config`
[As outlined here](development/build-flash.md), firmware comes in the form of .uf2 files, which can be built locally using the command `west build`. Normally,
`west build` will default to using the in-tree .keymap and .conf files found in your local copy of the `zmk` repository. However, you can append the command, `-DZMK_CONFIG="C:/the/absolute/path/config"` to `west build` in order to use the contents of your `zmk-config` folder instead of the
default keyboard settings.
**Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.**
For instance, building kyria firmware from a user `myUser`'s `zmk-config` folder on Windows 10 may look something like this:
```bash
west build -b nice_nano -- -DSHIELD=kyria_left -DZMK_CONFIG="C:/Users/myUser/Documents/Github/zmk-config/config"
```
:::note
It is also possible to build firmware locally on your computer by following the [toolchain setup](development/setup.md) and
[building instructions](development/build-flash.md), which includes pointers to
[building using your `zmk-config` folder](development/build-flash.md#building-from-zmk-config-folder).
:::
## Flashing Your Changes