From dd5806662a96c664953871b726bb1d8add949648 Mon Sep 17 00:00:00 2001 From: w0rp Date: Sat, 8 Jul 2017 14:42:39 +0100 Subject: [PATCH] Document how to install yamllint --- doc/ale-yaml.txt | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt index 6d441b51..4a24afa1 100644 --- a/doc/ale-yaml.txt +++ b/doc/ale-yaml.txt @@ -5,6 +5,25 @@ ALE YAML Integration *ale-yaml-options* =============================================================================== yamllint *ale-yaml-yamllint* +Website: https://github.com/adrienverge/yamllint + + +Installation +------------------------------------------------------------------------------- + +Install yamllint in your a virtualenv directory, locally, or globally: > + + pip install yamllint # After activating virtualenv + pip install --user yamllint # Install to ~/.local/bin + sudo pip install yamllint # Install globally + +See |g:ale_virtualenv_dir_names| for configuring how ALE searches for +virtualenv directories. + + +Options +------------------------------------------------------------------------------- + g:ale_yaml_yamllint_executable *g:ale_yaml_yamllint_executable* *b:ale_yaml_yamllint_executable* Type: |String|