Skip to content

Commit 6ac0b8f

Browse files
committed
doc: clarify luacheck installation
1 parent 05732cc commit 6ac0b8f

1 file changed

Lines changed: 24 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,38 @@ Thank you for your contribution!
66

77
Code is formatted using *stylua* and linted using *luacheck*.
88

9-
You can install these with:
9+
### stylua
10+
11+
Install via your OS package manager e.g. *Arch Linux*:
12+
13+
```sh
14+
pacman -S stylua
15+
```
16+
17+
or using cargo:
1018

1119
```sh
1220
cargo install stylua
13-
luarocks install luacheck
21+
```
22+
23+
### luacheck
24+
25+
Install using luarocks (preferred):
26+
27+
```sh
28+
luarocks install --local luacheck
1429
```
1530

1631
or via your OS package manager e.g. *Arch Linux*:
1732

1833
```sh
19-
pacman -S stylua luacheck
34+
pacman -S luacheck
35+
```
36+
37+
If you experience `luarocks` dependency issues installing `luacheck`, you may need to set an older lua version e.g.
38+
39+
```sh
40+
luarocks config --local lua_version 5.1
2041
```
2142

2243
## Adding icons

0 commit comments

Comments
 (0)