Skip to content

made required location of shield files for local builds explicit in readme#143

Open
ThePurox wants to merge 2 commits intourob:mainfrom
ThePurox:main
Open

made required location of shield files for local builds explicit in readme#143
ThePurox wants to merge 2 commits intourob:mainfrom
ThePurox:main

Conversation

@ThePurox
Copy link
Copy Markdown

@ThePurox ThePurox commented Mar 8, 2026

I found it quite unintuitive that files for custom shields need to go into zmk/app/boards/shields instead of boards/shields so I made it explicit in the readme.
When the files are in boards/shields one get error messages, that the shield files are used, but at the same time, that the shield is invalid.

Thank you for the amazing repo and the local toolchain setup 💜

@urob
Copy link
Copy Markdown
Owner

urob commented Mar 11, 2026

The problem with that approach is that changes to zmk get wiped out if you run just update. The better approach would be to add the shield as a west module.

@ThePurox
Copy link
Copy Markdown
Author

I was not aware of that, thank you!
I've updated the text to lay out how to do the same with a west module.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants