Browse Source

Includes instructions on how to install qmk and install its dependencies

main
Abhas Abhinav 3 years ago
parent
commit
d00f338d51
1 changed files with 23 additions and 0 deletions
  1. +23
    -0
      readme.md

+ 23
- 0
readme.md View File

@ -43,6 +43,29 @@ can be used in a similar manner with multiple video conferencing tools.
make git-submodule 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/`: 3. Clone [this repository](https://sovran.dev/mh/vckyb6) into `keyboards/mh/`:
``` ```


Loading…
Cancel
Save