From d00f338d51fe3c5bb238723459e0e0a1bf43ce0c Mon Sep 17 00:00:00 2001 From: Abhas Abhinav Date: Fri, 9 Jul 2021 13:04:07 +0530 Subject: [PATCH] Includes instructions on how to install qmk and install its dependencies --- readme.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/readme.md b/readme.md index 6ba7990..f4b943b 100644 --- a/readme.md +++ b/readme.md @@ -43,6 +43,29 @@ can be used in a similar manner with multiple video conferencing tools. make git-submodule ``` +3. Install the `qmk` command-line interface: + + ``` + apt-get install python3 python3-pip + pip3 install qmk + ``` + +4. Setup `qmk dependencies`: + + ``` + cd qmk_firmware/ + qmk setup + ``` + + Running `qmk setup` should install the necessary tools required to compile + and flash the keyboard firmware. On Debian, this will do the equivalent of: + + ``` + apt-get install build-essential avr-gcc arm-none-eabi-gcc avrdude dfu-util dfu-programmer + ``` + + Now you should be able to compile your firmware. + 3. Clone [this repository](https://sovran.dev/mh/vckyb6) into `keyboards/mh/`: ```