mirror of
https://github.com/dtomlinson91/panaetius.git
synced 2025-12-22 21:15:44 +00:00
updating documentation
This commit is contained in:
30
README.rst
30
README.rst
@@ -24,23 +24,37 @@ Read the documentation on `read the docs`_.
|
||||
Installation
|
||||
==============
|
||||
|
||||
You can install ..:obj:`panaetius`
|
||||
|
||||
Easy Way
|
||||
=========
|
||||
You can install ``panaetius`` the following ways:
|
||||
|
||||
Python
|
||||
-------
|
||||
|
||||
From pip
|
||||
~~~~~~~~~
|
||||
Install into a virtual environment.
|
||||
|
||||
From pypi using pip
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pip install panaetius
|
||||
|
||||
From local wheel
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
Download the latest verion from the `releases`_ page:
|
||||
|
||||
.. _releases: https://github.com/dtomlinson91/panaetius/releases
|
||||
|
||||
Install with pip:
|
||||
|
||||
.. code-block:: bash
|
||||
pip install -U panaetius-1.0.2-py3-none-any.whl
|
||||
|
||||
|
||||
From source
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Example Usage
|
||||
==============
|
||||
Clone the repo and install using ``setup.py``:
|
||||
|
||||
.. code-block:: bash
|
||||
python setup.py
|
||||
|
||||
Reference in New Issue
Block a user