commit 80c4200defaf9c5e5c4831d56e58a6733248fe4c parent 7b553a8e476c92f255f113f5d5d4546a468b2c3e Author: Claudio Alessi <smoppy@gmail.com> Date: Thu, 11 Aug 2022 23:09:51 +0200 Add a README with informations on how to getting started Diffstat:
| A | README | | | 16 | ++++++++++++++++ |
1 file changed, 16 insertions(+), 0 deletions(-)
diff --git a/README b/README @@ -0,0 +1,16 @@ +Setup +===== +$ python3 -m pip install --user qmk +$ export PATH="$PATH:$HOME/.local/bin" +$ qmk setup -H ~/sources/qmk_firmware + +Copy the keymap directories into the QMK tree. + +Usage +===== +$ qmk <command> -kb <keyboard> -km <keymap> + +For example: + +$ qmk compile -kb ymdk/yd60mq -km clamiax +$ qmk flash -kb ymdk/yd60mq -km clamiax