From b4cc269ab30c0b0ae9c91e7abd8ba74c46eb91f7 Mon Sep 17 00:00:00 2001 From: sajenim Date: Tue, 25 Jul 2023 12:32:12 +0800 Subject: [PATCH] update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f8f5905..a5492ee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ -# qmk_keymap +# QMK Keymaps +Personal keymaps for programmable keyboards. + +## Keyboards +- [Keychron Q4](https://www.keychron.com/products/keychron-q4-qmk-via-custom-mechanical-keyboard) +- [Corne Cherry](https://github.com/foostan/crkbd) + +## In Progress +- [Void30](https://github.com/victorlucachi/void30) +- [Dactyl Manuform](https://github.com/abstracthat/dactyl-manuform) + +## Keymaps + +## Pictures + +## Install +Follow the [getting started](https://docs.qmk.fm/#/newbs_getting_started) docs to install [QMK Firmware](https://docs.qmk.fm/#/) + + # Clone the keymaps + git clone https://github.com/sajenim/qmk_keymaps.git + + # Merge our keymaps into qmk_firmware rsync --recursive qmk_keymaps/keyboards/ qmk_firmware/keyboards/ + + # Compile the firmware + qmk compile -kb crkbd -km sajenim