From 688858e63957aacf5c5ca16f3e824867507faea9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Wed, 2 Mar 2016 19:07:35 +0100 Subject: [PATCH] Doc: Reference Fedora and Ubuntu packages --- README.rst | 17 +++++++++++++++++ docs/quickstart.rst | 28 +++++++++++++++++++++------- 2 files changed, 38 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 3bcbd7e..1129a9a 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 25a0dc3..92127a2 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -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 `), it can be passed to yamllint using the ``-c`` option: -:: +.. code:: bash yamllint -c ~/myconfig file.yml