NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2024-11-22 07:36:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: Simplify installation instruction in the README

Browse Source
This commit is contained in:
Adrien Vergé 2019-07-07 18:00:24 +02:00
parent f6a24552d9
commit 930c8eea94
2 changed files with 13 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.rst
View File

@ -38,38 +38,16 @@ Screenshot
Installation Installation
^^^^^^^^^^^^ ^^^^^^^^^^^^
On Fedora / CentOS (note: `EPEL <https://fedoraproject.org/wiki/EPEL>`_ is Using pip, the Python package manager:
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:
.. code:: bash .. code:: bash
pip install --user yamllint pip install --user yamllint
yamllint is also packaged for all major operating systems, see installation
examples (``dnf``, ``apt-get``...) `in the documentation
<https://yamllint.readthedocs.io/en/stable/quickstart.html>`_.
Usage Usage
^^^^^ ^^^^^

9
docs/quickstart.rst
View File

@ -4,7 +4,8 @@ Quickstart
Installing yamllint Installing yamllint
------------------- -------------------
On Fedora / CentOS: On Fedora / CentOS (note: `EPEL <https://fedoraproject.org/wiki/EPEL>`_ is
required on CentOS):
.. code:: bash .. code:: bash
@ -22,6 +23,12 @@ On Mac OS 10.11+:
brew install yamllint brew install yamllint
On FreeBSD:
.. code:: sh
pkg install py36-yamllint
Alternatively using pip, the Python package manager: Alternatively using pip, the Python package manager:
.. code:: bash .. code:: bash