path: root/README.md
diff options
authorTom Ryder <tom@sanctum.geek.nz>2017-10-30 18:36:18 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-10-30 18:36:18 +1300
commit1eef391006a3c70b7361b6480c8922d1a29c7a7d (patch)
tree37fd358093c2656b3af7f076c16723ed3c618c1a /README.md
parentMove non-indent HTML Vim config indent->ftplugin (diff)
parentAdd a `lint-vim` target for linting Vim config (diff)
Merge branch 'vim/vint'
The Vim configuration, excluding the submodule plugin bundles, now passes a strict run of the vim-vint tool. There's also now a `lint-vim` target in the Makefile.
Diffstat (limited to 'README.md')
1 files changed, 14 insertions, 4 deletions
diff --git a/README.md b/README.md
index 56407e8c..20a67a37 100644
--- a/README.md
+++ b/README.md
@@ -584,10 +584,20 @@ You can check that both sets of shell scripts are syntactically correct with
the scripts in `bin` and `games`. There's no proper test suite for the actual
functionality (yet).
-If you have [ShellCheck](https://www.shellcheck.net/) and/or
-[Perl::Critic](http://perlcritic.com/), there's a `lint` target for the shell
-script files and Perl files respectively. The files don't need to pass that
-check to be installed.
+There are also optional `lint` targets, if you have the appropriate tools
+available to run them:
+* [ShellCheck](https://www.shellcheck.net/):
+ * `lint-bash`
+ * `lint-bin`
+ * `lint-games`
+ * `lint-ksh`
+ * `lint-sh`
+ * `lint-xinit`
+* [Perl::Critic](https://perlcritic.com/):
+ * `lint-urxvt`
+* [Vint](https://github.com/Kuniwak/vint):
+ * `lint-vim`
Known issues