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

Remove coupling with Miryoku ZMK repository #72

Open
6 tasks
kucera-lukas opened this issue Dec 31, 2024 · 0 comments
Open
6 tasks

Remove coupling with Miryoku ZMK repository #72

kucera-lukas opened this issue Dec 31, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kucera-lukas
Copy link
Owner

kucera-lukas commented Dec 31, 2024

This repo has originally started as a fork of the Miryoku ZMK repository (https://github.com/manna-harbour/miryoku_zmk). Since then I've made lots of changes to every Miryoku layer and overrode most of the logic via the custom_config.h file.

Since my changes have diverged so much from base Miryoku, it's only an extra overhead to keep the repo aligned with upstream structure. On the other hand, there's nothing wrong with the current setup and it works well -- it might take me a while to find the time to do this work.

List of items to be done:

  • Remove "layer lock" functionality (u_to_U_*) -- I don't use it and it causes confusion
  • Standardize build processes. Current build process is too generic for my use-case and isn't well integrated with the native way to use the various ZMK tooling: zmkfirmware/zmk/.github/workflows/build-user-config, https://github.com/urob/zmk-actions, https://github.com/urob/zmk-helpers, build.yaml, west.yaml, ... -- ultimately it might be the easiest to start from a fresh ZMK config repo (https://zmk.dev/docs/user-setup)
  • Remove Miryoku "feature flags" (MIRYOKU_KLUDGE_DOUBLETAPBOOT, MIRYOKU_KLUDGE_MOUSEKEYSPR, ...)
  • Remove alternative layers (and layer selection)
  • Remove unused keyboards (definitions, github actions, keymaps, build examples, outboards, shields)
  • Documentation (e.g. local/remote builds). Relates to Update README with personal notes #20
@kucera-lukas kucera-lukas added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 31, 2024
@kucera-lukas kucera-lukas self-assigned this Dec 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant