Skip to content

Commit 479dcf1

Browse files
committed
Remove shell prompts from commands in README.md [ci skip]
1 parent 4aeb7bd commit 479dcf1

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ Luacheck supports checking Lua files using syntax of Lua 5.1, Lua 5.2, Lua 5.3 a
2424

2525
## Installation
2626

27-
The easiest way to install Luacheck is to use [LuaRocks](https://luarocks.org/). From your command line run the following command:
27+
The easiest way to install Luacheck is to use [LuaRocks](https://luarocks.org/). From your command line run the following command (using `sudo` if necessary):
2828

29-
```bash
30-
$ luarocks install luacheck # prepend with sudo if necessary
29+
```
30+
luarocks install luacheck
3131
```
3232

3333
If it is not possible to install [LuaFileSystem](http://keplerproject.github.io/luafilesystem/) in your environment, use `luarocks install luacheck --deps-mode=none`. For parallel checking Luacheck additionally requires [LuaLanes](https://github.com/LuaLanes/lanes), which can be installed using LuaRocks as well.
@@ -45,7 +45,10 @@ For manual installation, only a Lua interpreter binary is required.
4545
After Luacheck is installed, run `luacheck` program from the command line. Pass a list of files, [rockspecs](https://github.com/keplerproject/luarocks/wiki/Rockspec-format) or directories (requires LuaFileSystem) to be checked:
4646

4747
```
48-
$ luacheck src extra_file.lua another_file.lua
48+
luacheck src extra_file.lua another_file.lua
49+
```
50+
51+
```
4952
Checking src/good_code.lua OK
5053
Checking src/bad_code.lua 3 warnings
5154

0 commit comments

Comments
 (0)