Browse Source

Add some basic doc on how to setup & build this as QMK submodule

master
MaxMalRichtig 2 years ago
parent
commit
dda8cfaf46
  1. 20
      README.md
  2. 1
      successful_build_with_qmk_commit.info

20
README.md

@ -1,2 +1,20 @@
# corne-malrichtig-layout
# Max mal Richtig's "miryoku-ish" QMK layout for the Corne Keyboard
## How to build this layout
This repo is intendend to be used as a submodule with the upstream QMK firmware.
1. Clone QMK - e.g. with `qmk setup`
2. Add this repo as a submodule to your local QMK clone:
`git submodule add https://this_repos_address <QMK_PATH>/keyboards/crkbd/keymaps/maxmalrichtig`
3. Build the keymap with `qmk compile -kb crkbd -km maxmalrichtig`
4. Flash both halfes of the board with `qmk flash -kb crkbd -km maxmalrichtig`
## With which QMK commit will this build?
(One of the) last successful builds was possible with the QMK commit you can find in [successful_build_with_qmk_commit.info](successful_build_with_qmk_commit.info).
## How do I get the current commit into this file?
From QMK directory:
`git rev-parse origin/HEAD > keyboards/crkbd/keymaps/maxmalrichtig/successful_build_with_qmk_commit.info`

1
successful_build_with_qmk_commit.info

@ -0,0 +1 @@
f2c9fa81dead728a29d5a0b107658677687f837a
Loading…
Cancel
Save