summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArturs Artamonovs <dos21h@gmail.com>2023-03-09 22:47:36 +0000
committerArturs Artamonovs <dos21h@gmail.com>2023-03-09 22:47:36 +0000
commit194f0c07ecbab61eb383c9d17c72fb73a4c9af80 (patch)
treea70fdd9a8e1235e1b35fbdd735ecaf9cdb7c0e41 /README.md
parentc1ae0bcdb4eb27404d132b108f3d8da5ccdcf817 (diff)
parentfba22599d2ce386517c5c7f93403e0b3a4c92877 (diff)
downloadpyairspyhf-194f0c07ecbab61eb383c9d17c72fb73a4c9af80.tar.gz
pyairspyhf-194f0c07ecbab61eb383c9d17c72fb73a4c9af80.zip
Adding test for class. Implementeing main class. cleaning/fixing airspyhf_rx
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/README.md b/README.md
index fd99dac..d555884 100644
--- a/README.md
+++ b/README.md
@@ -5,8 +5,9 @@ Python wrapper of airspyhf library
https://github.com/airspy/airspyhf.git
Project webpage main.lv
+main project page http://main.lv
+cgit source viewer http://git.main.lv/cgit.cgi/pyairspyhf.git
-http://git.main.lv/cgit.cgi/pyairspyhf.git
# Source code
@@ -14,6 +15,35 @@ http://git.main.lv/cgit.cgi/pyairspyhf.git
git clone https://git.main.lv/cgit/pyairspyhf.git
```
+# Install airspyhf
+
+Install all dependencies such as:
+```
+ cmake, libusb
+```
+
+Checked supported and tested version list
+
+To build the libairspyhf follow: https://github.com/airspy/airspyhf
+
+Workes localy
+```
+git clone https://github.com/airspy/airspyhf.git
+cd airspyhf
+cmake .
+make
+sudo make install
+```
+
+If there is issues with libusb header try to find libusb header locations
+```
+cmake -DLIBUSB_INCLUDE_DIR=/usr/include/libusb-1.0/ -DINSTALL_UDEV_RULES=ON
+```
+
+```commandline
+udevadm control --reload-rules
+```
+
# API
## libairspyhf
@@ -23,6 +53,13 @@ git clone https://git.main.lv/cgit/pyairspyhf.git
## airspyhf_rx.py
+## Supported and tested
+
+| --- | --- | --- | --- |
+| Python | libairspyhf | OS | Status |
+| --- |--- | --- | --- |
+| 3.9, 3.10 | 1.7.1 | ArchLinux, Ubuntu 20.04 | Supported and tested |
+
## Install