Doc: Reference Fedora and Ubuntu packages
This commit is contained in:
17
README.rst
17
README.rst
@@ -38,6 +38,23 @@ Screenshot
|
|||||||
Installation
|
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
|
.. code:: bash
|
||||||
|
|
||||||
sudo pip install yamllint
|
sudo pip install yamllint
|
||||||
|
|||||||
@@ -4,16 +4,30 @@ Quickstart
|
|||||||
Installing yamllint
|
Installing yamllint
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
First, install yamllint. The easiest way is to use pip, the Python package
|
On Fedora / CentOS :
|
||||||
manager:
|
|
||||||
|
|
||||||
::
|
.. 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
|
sudo pip install yamllint
|
||||||
|
|
||||||
If you prefer installing from source, you can run, from the source directory:
|
If you prefer installing from source, you can run, from the source directory:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
python setup.py sdist
|
python setup.py sdist
|
||||||
sudo pip install dist/yamllint-*.tar.gz
|
sudo pip install dist/yamllint-*.tar.gz
|
||||||
@@ -23,13 +37,13 @@ Running yamllint
|
|||||||
|
|
||||||
Basic usage:
|
Basic usage:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
yamllint file.yml other-file.yaml
|
yamllint file.yml other-file.yaml
|
||||||
|
|
||||||
You can also lint all YAML files in a whole directory:
|
You can also lint all YAML files in a whole directory:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
yamllint .
|
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``
|
yamllint <configuration>`), it can be passed to yamllint using the ``-c``
|
||||||
option:
|
option:
|
||||||
|
|
||||||
::
|
.. code:: bash
|
||||||
|
|
||||||
yamllint -c ~/myconfig file.yml
|
yamllint -c ~/myconfig file.yml
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user