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.

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

convert to zmk/zephyr module compatible repo #18

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

Conversation

kitchen
Copy link

@kitchen kitchen commented Apr 11, 2024

a la https://zmk.dev/docs/development/new-shield

This makes it possible to include the shield as a third party module into larger config repos. You can still easily override things with local overlays and such. e.g. I just helped someone who soldered all of the diodes on the right hand backward, and if they were using this repo as a module they would have needed a basically 3 line override to switch row2col/col2row on their right hand.

Then there are the weird people like me who have many keebs and like to have everything in one config repo, but since this isn't zmk upstream I'd have to copy/paste the whole shield directory in, whereas with this being a module I just include it and it's good.

This doesn't break the existing "fork this repo and change the keymap" workflow, either, though if folks are following upstream and have local changes there may be some issues but most likely the best approach to resolving those issues would be to remove the entire shield def from their config repo, add the module, then do any overrides in their config/ dir

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.

None yet

1 participant