Skip to content

Commit 52b9a13

Browse files
committed
style: 💄 Bash
1 parent 87b880a commit 52b9a13

1 file changed

Lines changed: 27 additions & 9 deletions

File tree

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,24 @@ Details here: https://github.com/maatthc/keyboard_layers_app_companion
3535

3636
### Install and setup
3737
- Install QMK:
38-
`python3 -m pip install qmk`
38+
```
39+
python3 -m pip install qmk
40+
```
3941

4042
- Initialize the sub-modules:
41-
`git submodule update --init --recursive`
43+
```
44+
git submodule update --init --recursive
45+
```
4246

4347
- Set this folder as an userspace:
44-
`qmk config user.overlay_dir="$(realpath qmk_userspace)"`
48+
```
49+
qmk config user.overlay_dir="$(realpath qmk_userspace)"
50+
```
4551

4652
- Set up QMK:
47-
`cd ..; qmk setup`
53+
```
54+
cd ..; qmk setup
55+
```
4856

4957
#### Piantor
5058
```
@@ -65,20 +73,30 @@ export PATH=${PWD}/avr_toolchain/bin:$PATH
6573
```
6674

6775
### Compile
68-
`qmk compile -kb $KEYBOARD -km maat`
76+
```
77+
qmk compile -kb $KEYBOARD -km maat
78+
```
6979

7080
### Flash
71-
`qmk flash -kb $KEYBOARD -km maat`
81+
```
82+
qmk flash -kb $KEYBOARD -km maat
83+
```
7284

7385
### Generates the Clang compile_commands.json
74-
`qmk compile --compiledb -kb $KEYBOARD -km maat`
86+
```
87+
qmk compile --compiledb -kb $KEYBOARD -km maat
88+
```
7589

7690
### Check debug logs
77-
`qmk console`
91+
```
92+
qmk console
93+
```
7894

7995
### info
8096

81-
`qmk info -kb $KEYBOARD -km maat`
97+
```
98+
qmk info -kb $KEYBOARD -km maat
99+
```
82100

83101
## Configuration
84102

0 commit comments

Comments
 (0)