From 76f74089d6311e5f48a06ba130b8b324a249f24e Mon Sep 17 00:00:00 2001 From: Marc Lichtman Date: Thu, 14 Sep 2023 05:33:10 -0400 Subject: [PATCH] Update README.md install from source On two diff machines I got the `Successfully installed UNKNOWN-0.0.0` issue before updating pip --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0751f66a3..95077a1b2 100644 --- a/README.md +++ b/README.md @@ -58,37 +58,38 @@ data = sdr.rx() ### Installing from source ``` -tcollins@jeeves:~$ git clone https://github.com/analogdevicesinc/pyadi-iio.git -tcollins@jeeves:~$ cd pyadi-iio -tcollins@jeeves:~$ (sudo) pip install . +git clone https://github.com/analogdevicesinc/pyadi-iio.git +cd pyadi-iio +(sudo) python3 -m pip install pip -U +(sudo) pip install . ``` ### Installing from pip ``` -tcollins@jeeves:~$ (sudo) pip install pyadi-iio +(sudo) pip install pyadi-iio ``` To get optional dependency for JESD debugging ``` -tcollins@jeeves:~$ (sudo) pip install pyadi-iio[jesd] +(sudo) pip install pyadi-iio[jesd] ``` ### Building doc Install necessary tools ``` -tcollins@jeeves:~$ (sudo) pip install -r requirements_doc.txt +(sudo) pip install -r requirements_doc.txt ``` Build actual doc with sphinx ``` -tcollins@jeeves:~$ cd doc -tcollins@jeeves:~$ make html +cd doc +make html ``` ### Developing Install necessary tools ``` -tcollins@jeeves:~$ (sudo) pip install -r requirements_dev.txt +(sudo) pip install -r requirements_dev.txt ``` Running pre-commit checks ``` -tcollins@jeeves:~$ pre-commit run --all-files +pre-commit run --all-files ```