Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme.org - ZMK Docker Build Subsection #57

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

readme.org - ZMK Docker Build Subsection #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions readme.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ First [[https://zmk.dev/docs/development/setup][set up the ZMK build environment
Clone this repository and set [[https://zmk.dev/docs/development/build-flash#building-from-zmk-config-folder][ZMK_CONFIG]] to the absolute path of the [[config]] subdirectory. Use the [[#config-file][config file]] to select alternative layout and mapping options.


**** Docker Builds
If using the [[https://zmk.dev/docs/development/setup/docker][ZMK Docker build environment]], create your [[https://zmk.dev/docs/development/build-flash#building-from-zmk-config-folder][zmk-config volume]] with the ~device~ argument set to the absolute path of your ~miryoku_zmk~ directory. [[https://github.com/manna-harbour/miryoku_zmk][Miryoku ZMK]] must be in the ~zmk-config~ volume in order for your keymap to build.

The [[config]] subdirectory can then be provided at build time.
: -DZMK_CONFIG="/workspaces/zmk-config/config"


*** Workflow Builds

Firmware can be built via GitHub Actions workflows without use of a local build environment.
Expand Down