zmkfirmware / zmkfirmware/zmk-cli
Make CLI copy and rename `.conf.template` when setting up a keyboard
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Due to how .conf files work when they are in the board directory, I think we should introduce .conf.template files in them and then have them copied over and renamed to .conf files in the user's config. This would have things like
# Enable this to allow your keyboard to sleep
# CONFIG_ZMK_SLEEP=y
I think it would be best if this was enabled in the CLI first (and the CLI becomes the default way to setup), before we make the appropriate changes to the in-tree keyboards and documentation.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the CLI flow that sets up a keyboard and inspect how configuration files are currently created in the user's config. The work is done when the CLI copies each keyboard .conf.template file into the user's config and renames it to .conf, with the intended template contents preserved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100