From ed544d55ac96541a562f534ec6caaa6aa2ab4c74 Mon Sep 17 00:00:00 2001 From: Lukas Magel Date: Wed, 8 Jan 2025 20:06:18 +0100 Subject: [PATCH] Update the README to feature installation via pip --- README.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 0f2aec4..9f4da2d 100644 --- a/README.rst +++ b/README.rst @@ -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: