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

incorporate suggestions from PR comments

Browse source
This commit is contained in:
Jeremy Kitchen 2021-10-22 12:17:22 -07:00
parent 850a335e58
commit e2b5e4106d
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/docs/development/build-flash.md
View file

@ -92,7 +92,7 @@ This produces `left` and `right` subfolders under the `build` directory and two
Getting your `zmk-config` to be used by your build environment differs based on what type of build environment you are using. Getting your `zmk-config` to be used by your build environment differs based on what type of build environment you are using.
#### non-containerized environment #### Local/Host Build Environment.
Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](../user-setup#github-repo) by adding Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](../user-setup#github-repo) by adding
`-DZMK_CONFIG="C:/the/absolute/path/config"` to your `west build` command. **Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.** `-DZMK_CONFIG="C:/the/absolute/path/config"` to your `west build` command. **Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.**
@ -120,11 +120,11 @@ docker volume create --driver local -o o=bind -o type=none -o \
device="/full/path/to/your/zmk-config/" zmk-config device="/full/path/to/your/zmk-config/" zmk-config
``` ```
Now start VSCode and rebuild the container after being prompted. You should be able to see your zmk-config mounted to `/workspaces/zmk-config` inside the container. So you can build your custom firmware with `-DZMK_CONFIG="/workspaces/zmk-config/config"`. Now start VSCode and rebuild the container after being prompted. You should be able to see your zmk-config mounted to `/workspaces/zmk-config` inside the container. So you can build your custom firmware by adding `-DZMK_CONFIG="/workspaces/zmk-config/config"` to your `west build` command.
#### docker compose build environment #### Docker Compose Build Environment
Attaching your `zmk-config` to your docker-compose build environment is done by specifying a volume mount when running the service: ATTACHING your `zmk-config` to your docker-compose build environment is done by specifying a volume mount when running the service:
``` ```
docker compose run --rm -v /full/path/to/your/zmk-config:/workspace/zmk-config shell bash docker compose run --rm -v /full/path/to/your/zmk-config:/workspace/zmk-config shell bash

2
docs/docs/development/setup.md
View file

@ -16,7 +16,7 @@ values={[
{label: 'Raspberry OS', value: 'raspberryos'}, {label: 'Raspberry OS', value: 'raspberryos'},
{label: 'Fedora', value: 'fedora'}, {label: 'Fedora', value: 'fedora'},
{label: 'VS Code & Docker', value: 'docker'}, {label: 'VS Code & Docker', value: 'docker'},
{label: 'docker compose', value: 'dockercompose'}, {label: 'Docker Compose', value: 'dockercompose'},
] ]
}>{props.children}</Tabs>); }>{props.children}</Tabs>);