From dda8cfaf46b76b0aff133657b01d69919e7a9fed Mon Sep 17 00:00:00 2001 From: MaxMalRichtig Date: Tue, 1 Feb 2022 23:21:35 +0100 Subject: [PATCH] Add some basic doc on how to setup & build this as QMK submodule --- README.md | 20 +++++++++++++++++++- successful_build_with_qmk_commit.info | 1 + 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 successful_build_with_qmk_commit.info diff --git a/README.md b/README.md index f1320f8..7362d55 100644 --- a/README.md +++ b/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 /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` diff --git a/successful_build_with_qmk_commit.info b/successful_build_with_qmk_commit.info new file mode 100644 index 0000000..0f489e9 --- /dev/null +++ b/successful_build_with_qmk_commit.info @@ -0,0 +1 @@ +f2c9fa81dead728a29d5a0b107658677687f837a