Skip to content

Update readme.org #40

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.

Sign up for GitHub

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

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

Update readme.org #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions users/manna-harbour_miryoku/readme.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ New commits can be seen at the top of the [[https://github.com/manna-harbour/mir

Periodically, the ~[miryoku]~ commits are squashed and merged upstream into QMK master by pull request, the ~miryoku~ branch is renamed, and a new ~miryoku~ branch is created from QMK master.

**** NOTE:
As of 5/28/2025, there is an issue with merging the Miryoku QMK Development branch with the most recent QMK, described [[https://github.com/manna-harbour/miryoku/discussions/287][here]].
If you are okay with using a slightly outdated version of QMK, do the following:

During [[https://docs.qmk.fm/newbs_getting_started][install of QMK]], skip the step ~qmk setup~
Instead, you should clone this repo with the QMK clone feature: ~qmk clone manna-harbour/miryoku_qmk -b miryoku~
Then you can start compiling firmware.

**** Merge

Expand Down