Skip to content

Commit

Permalink
Update the README to feature installation via pip
Browse files Browse the repository at this point in the history
  • Loading branch information
lumagi committed Jan 8, 2025
1 parent d13ed35 commit ed544d5
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,21 @@ configure udev rules to ensure that the device names are consistent.

pyshimmer Package
^^^^^^^^^^^^^^^^^
In order to install the package itself, clone it and use pip to install it:
The easiest and quickest way is to install the latest release with pip:

.. code-block::
git clone https://github.com/seemoo-lab/pyshimmer.git
cd pyshimmer
pip install .
pip install pyshimmer
From Source with Tests
^^^^^^^^^^^^^^^^^^^^^^

If you want to run the tests, instead install the package with :code:`test` extras:
You can also install from source in case you would like to run the tests:

.. code-block::
git clone https://github.com/seemoo-lab/pyshimmer.git
cd pyshimmer
pip install .[test]
You can then run the tests from the repository root by simply issuing:
Expand Down

0 comments on commit ed544d5

Please sign in to comment.