Skip to content
This repository has been archived by the owner on Mar 28, 2024. It is now read-only.

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@critical-path
critical-path committed Sep 14, 2019
1 parent 075e95f commit 2822da6
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 42 deletions.
26 changes: 5 additions & 21 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@ Installing macaddress

macaddress is available on GitHub at https://github.com/critical-path/macaddress.

If your version of pip is >= 18.1:
----------------------------------
If you do not have pip version 18.1 or higher, then run the following command from your shell.

.. code-block:: console
[user@host ~]$ sudo pip install --upgrade pip
To install macaddress with test-related dependencies, run the following command from your shell.

Expand All @@ -35,25 +38,6 @@ To install it without test-related dependencies, run the following command from
[user@host ~]$ sudo pip install git+https://github.com/critical-path/macaddress.git
If your version of pip is < 18.1:
---------------------------------

To install macaddress with test-related dependencies, run the following commands from your shell.

.. code-block:: console
[user@host ~]$ git clone git@github.com:critical-path/macaddress.git
[user@host ~]$ cd macaddress
[user@host macaddress]$ sudo pip install --editable .[test]
To install it without test-related dependencies, run the following commands from your shell.

.. code-block:: console
[user@host ~]$ git clone git@github.com:critical-path/macaddress.git
[user@host ~]$ cd macaddress
[user@host macaddress]$ sudo pip install .
(If necessary, replace :code:`pip` with :code:`pip3`.)


Expand Down
26 changes: 5 additions & 21 deletions docs/install.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@ Installing macaddress

macaddress is available on GitHub at https://github.com/critical-path/macaddress.

If your version of pip is >= 18.1:
----------------------------------
If you do not have pip version 18.1 or higher, then run the following command from your shell.

.. code-block:: console
[user@host ~]$ sudo pip install --upgrade pip
To install macaddress with test-related dependencies, run the following command from your shell.

Expand All @@ -18,23 +21,4 @@ To install it without test-related dependencies, run the following command from
[user@host ~]$ sudo pip install git+https://github.com/critical-path/macaddress.git
If your version of pip is < 18.1:
---------------------------------

To install macaddress with test-related dependencies, run the following commands from your shell.

.. code-block:: console
[user@host ~]$ git clone git@github.com:critical-path/macaddress.git
[user@host ~]$ cd macaddress
[user@host macaddress]$ sudo pip install --editable .[test]
To install it without test-related dependencies, run the following commands from your shell.

.. code-block:: console
[user@host ~]$ git clone git@github.com:critical-path/macaddress.git
[user@host ~]$ cd macaddress
[user@host macaddress]$ sudo pip install .
(If necessary, replace :code:`pip` with :code:`pip3`.)

0 comments on commit 2822da6

Please sign in to comment.