From c801962c6e4ec6c6f6fd060ea21e1b8726982359 Mon Sep 17 00:00:00 2001 From: inkch Date: Fri, 23 Aug 2024 12:22:48 +0900 Subject: [PATCH] add readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..372e323 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# inkch's `crkbd` keymap + +I initially followed QMK's recommendation to fork their entire repository +(`qmk/qmk_firmaware`) to maintain custom keymaps. +However, after hosting my forked repository here, I encountered an unexpected +issue: +it attracted an overwhelming amount of traffic that put too much strain on my +server resources. +Despite my desire to share my codes with the public, this situation was +unsustainable. + +As a result, I've decided to create a new repository specifically for my custom +keymaps, which will allow me to continue sharing my work while keeping the load +manageable and easy to maintain. + + +## How to use + +1. Pull [`qmk/qmk_firmware`](https://github.com/qmk/qmk_firmware) +2. [Set up QMK Env](https://docs.qmk.fm/newbs_getting_started) +3. Clone this repo into `/keyboards/crkbd/keymaps/`