Skip to content

Commit

Permalink
doc: add install instruction with conda
Browse files Browse the repository at this point in the history
  • Loading branch information
Antoine DECHAUME committed May 18, 2020
1 parent 2478c25 commit daf6810
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 59 deletions.
15 changes: 10 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Pytest-executable
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

``pytest-executable`` is a `pytest`_ plugin for simplifying the black-box
*pytest-executable* is a `pytest`_ plugin for simplifying the black-box
testing of an executable, be it written in python or not. It helps to avoid
writing the boilerplate test code to spawn subprocesses, to handle the output
and references directory trees and to define the execution context. It
Expand All @@ -42,14 +42,17 @@ The project documentation is available `online`_.
Installation
------------

Install using `pip <http://pip-installer.org/>`_:
Install using `pip`_:

.. code-block:: console
pip install pytest-executable
A ``pytest-executable`` package will soon be available in Conda-Forge (just a
matter of free time).
Install using `conda`_:

.. code-block:: console
conda install pytest-executable -c conda-forge
Contributing
Expand All @@ -73,11 +76,13 @@ Copyright and License

Copyright 2020, `CS GROUP`_

``pytest-executable`` is a free and open source software, distributed under the
*pytest-executable* is a free and open source software, distributed under the
Apache License 2.0. See the `LICENSE.txt`_ file for more information, or the
`quick summary`_ of this license on `tl;drLegal`_ website.


.. _conda: https://docs.conda.io
.. _pip: https://pip-installer.org
.. _pytest: https://docs.pytest.org
.. _online: https://pytest-executable.readthedocs.io
.. _Github issue tracker: https://github.com/CS-SI/pytest-executable/issues
Expand Down
11 changes: 9 additions & 2 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,25 @@
.. See the License for the specific language governing permissions and
.. limitations under the License.
.. _Sphinx: https://www.sphinx-doc.org
.. _conda: https://docs.conda.io
.. _pip: https://pip-installer.org


Installation
============

Install using `pip <http://pip-installer.org/>`_:
Install using `pip`_:

.. code-block:: console
pip install pytest-executable
Install using `conda`_:

.. code-block:: console
conda install pytest-executable -c conda-forge
Command line interface
======================
Expand Down
52 changes: 0 additions & 52 deletions meta.yaml

This file was deleted.

0 comments on commit daf6810

Please sign in to comment.