summaryrefslogtreecommitdiff
path: root/doc/ale-yaml.txt
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-07-08 14:42:39 +0100
committerw0rp <devw0rp@gmail.com>2017-07-08 14:42:39 +0100
commitdd5806662a96c664953871b726bb1d8add949648 (patch)
treedf2602ec944ed38cf683aeb7d3d393b3a95ce12f /doc/ale-yaml.txt
parent996732d5a688c8f0e56e0f5bfb17bdd11c819bbb (diff)
downloadale-dd5806662a96c664953871b726bb1d8add949648.zip
Document how to install yamllint
Diffstat (limited to 'doc/ale-yaml.txt')
-rw-r--r--doc/ale-yaml.txt19
1 files changed, 19 insertions, 0 deletions
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|