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

[Documentation Request] Please expand qmk userspace documentation to more thoroughly describe what can be overlaid and/or added to individual keyboard firmware, and also describe limitations. #34

Open
Steve973 opened this issue Nov 17, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Steve973
Copy link

Description

I am trying to understand exactly what can be overlaid in terms of keyboard files in the qmk userspace repo. Since the qmk.json file specifies build targets by the specific keymap level, it seems like the overlay would consist only of files that would exist in a specific keymap directory. Since the repo documentation in README.md is not specific about this, that is only an assumption. Some explanation about the scope of a build target overlay would be very helpful for people using this userspace repo. Though I am doubtful about the ability to do this with the userspace overlay, is there any way to overlay any files outside of a keymap directory? For example, if a config.h file exists at the keyboard level, it will affect the keymap, so if this is either possible, or impossible, it would be helpful to understand this, as well.

@Steve973 Steve973 added the enhancement New feature or request label Nov 17, 2024
@Steve973 Steve973 changed the title [Documentation Request] Please expand qmk userspace documentation to more thoroughly describe what can be overlaid and/or added to individual keyboard firmware [Documentation Request] Please expand qmk userspace documentation to more thoroughly describe what can be overlaid and/or added to individual keyboard firmware, and also describe limitations. Nov 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant