NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2025-02-25 18:55:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Reference Fedora and Ubuntu packages

Browse Source
This commit is contained in:
Adrien Vergé 2016-03-02 19:07:35 +01:00
parent dca3a54e63
commit 688858e639
2 changed files with 38 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -38,6 +38,23 @@ Screenshot
Installation
^^^^^^^^^^^^
On Fedora / CentOS :
.. code:: bash
sudo dnf install yamllint
On Ubuntu:
.. code:: bash
sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
sudo apt-get install yamllint
On Debian: an official package is coming, it should be available soon.
Alternatively using pip, the Python package manager:
.. code:: bash
sudo pip install yamllint

28
docs/quickstart.rst
View File

@ -4,16 +4,30 @@ Quickstart
Installing yamllint
-------------------
First, install yamllint. The easiest way is to use pip, the Python package
manager:
On Fedora / CentOS :
::
.. code:: bash
sudo dnf install yamllint
On Ubuntu:
.. code:: bash
sudo add-apt-repository -y ppa:adrienverge/ppa && sudo apt-get update
sudo apt-get install yamllint
On Debian: an official package is coming, it should be available soon.
Alternatively using pip, the Python package manager:
.. code:: bash
sudo pip install yamllint
If you prefer installing from source, you can run, from the source directory:
::
.. code:: bash
python setup.py sdist
sudo pip install dist/yamllint-*.tar.gz
@ -23,13 +37,13 @@ Running yamllint
Basic usage:
::
.. code:: bash
yamllint file.yml other-file.yaml
You can also lint all YAML files in a whole directory:
::
.. code:: bash
yamllint .
@ -65,7 +79,7 @@ If you have a custom linting configuration file (see :doc:`how to configure
yamllint <configuration>`), it can be passed to yamllint using the ``-c``
option:
::
.. code:: bash
yamllint -c ~/myconfig file.yml