Document how to install yamllint

This commit is contained in:
w0rp 2017-07-08 14:42:39 +01:00
parent 996732d5a6
commit dd5806662a
1 changed files with 19 additions and 0 deletions

View File

@ -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|