Skip to content

Commit

Permalink
Add brief usage section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Jun 15, 2021
1 parent f8ab70d commit ed627a8
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,17 @@ To install with ``conda``:
$ conda install whey-pth
.. end installation
-----

To enable ``whey-pth``, add the following lines to your ``pyproject.toml`` file:

.. code-block:: TOML
[tool.whey.builders]
wheel = "whey_pth_wheel"
The ``whey-pth``-specific configuration is defined in the ``tool.whey-pth`` table.
See `the documentation`_ for more details.

.. _the documentation: https://whey-pth.readthedocs.io/en/latest/

0 comments on commit ed627a8

Please sign in to comment.