aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 1df3161..6617aa4 100644
--- a/README.rst
+++ b/README.rst
@@ -11,6 +11,24 @@ Installing
* Gentoo users: ``emerge app-vim/gentoo-syntax``
* Everyone else: ``make PREFIX=~/.vim/ install``
+This plugin also provides a syntax checker for ebuilds and eclasses. To enable
+it, you need to install Syntastic_ and pkgcheck_ first::
+
+ # emerge app-vim/syntastic dev-util/pkgcheck
+
+Then you'll need to configure Syntastic (see ``:help syntastic-quickstart``)
+and add the following line to your .vimrc file::
+
+ let g:syntastic_ebuild_checkers = ['pkgcheck']
+
+To find non-POSIX code in OpenRC services, install ``dev-util/checkbashisms``
+and enable it for filetype "sh"::
+
+ let g:syntastic_sh_checkers = ['sh', 'checkbashisms']
+
+.. _Syntastic: https://github.com/vim-syntastic/syntastic
+.. _pkgcheck: https://github.com/pkgcore/pkgcheck
+
Bugs
====