From 930c8eea94614142daac00c24a9a5f51c8c43dc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrien=20Verg=C3=A9?= Date: Sun, 7 Jul 2019 18:00:24 +0200 Subject: [PATCH] docs: Simplify installation instruction in the README --- README.rst | 32 +++++--------------------------- docs/quickstart.rst | 9 ++++++++- 2 files changed, 13 insertions(+), 28 deletions(-) diff --git a/README.rst b/README.rst index 7f59956..0bebb78 100644 --- a/README.rst +++ b/README.rst @@ -38,38 +38,16 @@ Screenshot Installation ^^^^^^^^^^^^ -On Fedora / CentOS (note: `EPEL `_ is -required on CentOS): - -.. code:: bash - - sudo dnf install yamllint - -On Debian 8+ / Ubuntu 16.04+: - -.. code:: bash - - sudo apt-get install yamllint - -On FreeBSD: - -.. code:: sh - - pkg install py27-yamllint - pkg install py36-yamllint - -On Mac OS 10.11+: - -.. code:: bash - - brew install yamllint - -Alternatively using pip, the Python package manager: +Using pip, the Python package manager: .. code:: bash pip install --user yamllint +yamllint is also packaged for all major operating systems, see installation +examples (``dnf``, ``apt-get``...) `in the documentation +`_. + Usage ^^^^^ diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 427a9f3..8d959d6 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -4,7 +4,8 @@ Quickstart Installing yamllint ------------------- -On Fedora / CentOS: +On Fedora / CentOS (note: `EPEL `_ is +required on CentOS): .. code:: bash @@ -22,6 +23,12 @@ On Mac OS 10.11+: brew install yamllint +On FreeBSD: + +.. code:: sh + + pkg install py36-yamllint + Alternatively using pip, the Python package manager: .. code:: bash