Skip to content
This repository was archived by the owner on Aug 7, 2023. It is now read-only.

Commit 854893b

Browse files
author
Ted Behling
committed
Fixup README markdown per remark linter
1 parent 9f2ac4d commit 854893b

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,26 @@ instead prefer editing the configuration by hand you can get to that by editing
2828
`~/.atom/config.cson` (choose Open Your Config in Atom menu). The settings
2929
available are:
3030

31-
* `shellcheckExecutablePath`: The full path to the `shellcheck` executable.
32-
Run `which shellcheck` to find where it is installed on your system.
33-
34-
* `userParameters`: Any additional executable parameters to pass to
35-
`shellcheck` when linting your files.
36-
37-
* `enableNotice`: Include lesser-importance ShellCheck messages
38-
(default: false).
39-
40-
* `useProjectCwd`: Controls whether the paths used by ShellCheck's
41-
[`source=`](https://github.com/koalaman/shellcheck/wiki/Directive#source)
42-
directive are relative to the project root or the file (default: false, for file-relative)
43-
* If true, ShellCheck's working directory
44-
will be the project's root directory. Any `source=` directives will be
45-
interpreted relative to the project root.
46-
* Otherwise, ShellCheck will run relative to the file's directory,
47-
making `source=` directives file-relative.
31+
- `shellcheckExecutablePath`: The full path to the `shellcheck` executable.
32+
Run `which shellcheck` to find where it is installed on your system.
33+
34+
- `userParameters`: Any additional executable parameters to pass to
35+
`shellcheck` when linting your files.
36+
37+
- `enableNotice`: Include lesser-importance ShellCheck messages
38+
(default: false).
39+
40+
- `useProjectCwd`: Controls whether the paths used by ShellCheck's
41+
[`source=`](https://github.com/koalaman/shellcheck/wiki/Directive#source)
42+
directive are relative to the project root or the file (default: false, for
43+
file-relative)
44+
45+
- If true, ShellCheck's working directory
46+
will be the project's root directory. Any `source=` directives will be
47+
interpreted relative to the project root.
48+
49+
- Otherwise, ShellCheck will run relative to the file's directory,
50+
making `source=` directives file-relative.
4851

4952
[linter]: https://github.com/atom-community/linter "Linter"
5053
[shellcheck]: https://github.com/koalaman/shellcheck "ShellCheck"

0 commit comments

Comments
 (0)