-------------------------------------------------------------------------------
The sigrok project aims at creating a portable, cross-platform,
-Free/Libre/Open-Source logic analyzer software that supports various
-logic analyzer hardware products.
+Free/Libre/Open-Source signal analysis software suite that supports various
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).
libsigrok is a shared library written in C which provides the basic API
-for talking to logic analyzer hardware and reading/writing the acquired data
-into various input/output file formats.
+for talking to hardware and reading/writing the acquired data into various
+input/output file formats.
-Status and API
---------------
+Status
+------
-libsigrok is currently work in progress.
+libsigrok is in a usable state and has had official tarball releases.
-IMPORTANT: The API of libsigrok is NOT yet considered stable! Please do
- not rely on it, yet! Changes to function names, macro names etc.
- can happen at any time without prior notice!
+While the API can change from release to release, this will always be
+properly documented and reflected in the package version number and
+in the shared library / libtool / .so-file version numbers.
+
+However, there are _NO_ guarantees at all for stable APIs in git snapshots!
+Distro packagers should only use released tarballs (no git snapshots).
Requirements
------------
- - git
- - gcc
+Requirements for the C library:
+
+ - git (only needed when building from git)
+ - gcc (>= 4.0) or clang
- make
- - autoconf >= 2.63
- - automake >= 1.11
- - libtool
+ - autoconf >= 2.63 (only needed when building from git)
+ - automake >= 1.11 (only needed when building from git)
+ - libtool (only needed when building from git)
- pkg-config >= 0.22
- - libglib >= 2.22.0
- - libusb >= 1.0.5 (for most logic analyzer hardware)
- - libzip >= 0.8
- - zlib >= 1.2.3.1
- - libftdi >= 0.16 (for some logic analyzer hardware)
- - libudev >= 151 (for some logic analyzer hardware)
+ - libglib >= 2.32.0
+ - libzip >= 0.10
+ - libtirpc (optional, used by VXI, fallback when glibc >= 2.26)
+ - libserialport >= 0.1.1 (optional, used by some drivers)
+ - librevisa >= 0.0.20130412 (optional, used by some drivers)
+ - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
+ - hidapi >= 0.8.0 (optional, used for some HID based "serial cables")
+ - bluez/libbluetooth >= 4.0 (optional, used for Bluetooth/BLE communication)
+ - libftdi1 >= 1.0 (optional, used by some drivers)
+ - libgpib (optional, used by some drivers)
+ - libieee1284 (optional, used by some drivers)
+ - libgio >= 2.32.0 (optional, used by some drivers)
+ - check >= 0.9.4 (optional, only needed to run unit tests)
+ - doxygen (optional, only needed for the C API docs)
+ - graphviz (optional, only needed for the C API docs)
+
+Requirements for the C++ bindings:
+
+ - libsigrok >= 0.4.0 (the libsigrok C library, see above)
+ - A C++ compiler with C++11 support (-std=c++11 option), e.g.
+ - g++ (>= 4.8.1)
+ - clang++ (>= 3.3)
+ - autoconf-archive (only needed when building from git)
+ - doxygen (required for building the bindings, not only for C++ API docs!)
+ - graphviz (optional, only needed for the C++ API docs)
+ - Python (2 or 3) executable (development files are not needed)
+ - glibmm-2.4 (>= 2.32.0)
+
+Requirements for the Python bindings:
+
+ - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
+ - Python >= 2.7 or Python >= 3 (including development files!)
+ - Python setuptools (for Python 2 or 3)
+ - pygobject >= 3.0.0 (for Python 2 or 3), a.k.a python-gi
+ - numpy (for Python 2 or 3)
+ - SWIG >= 2.0.0
+ - doxygen (optional, only needed for the Python API docs)
+ - graphviz (optional, only needed for the Python API docs)
+ - doxypy (optional, only needed for the Python API docs)
+
+Requirements for the Ruby bindings:
+
+ - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
+ - Ruby >= 2.5.0 (including development files!)
+ - SWIG >= 3.0.8
+ - YARD (optional, only needed for the Ruby API docs)
+
+Requirements for the Java bindings:
+
+ - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
+ - SWIG >= 2.0.0
+ - Java JDK (for JNI includes and the javac/jar binaries)
+ - doxygen (optional, only needed for the Java API docs)
+ - graphviz (optional, only needed for the Java API docs)
Building and installing
In order to get the libsigrok source code and build it, run:
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
- $ cd sigrok/libsigrok
+ $ git clone git://sigrok.org/libsigrok
+ $ cd libsigrok
$ ./autogen.sh
$ ./configure
$ make
$ make install
-Please see the following wiki pages for more detailed instructions:
+See INSTALL or the following wiki page for more (OS-specific) instructions:
+
+ http://sigrok.org/wiki/Building
+
+Please also check the following wiki page in case you encounter any issues:
+
+ http://sigrok.org/wiki/Building#FAQ
+
+
+Device-specific issues
+----------------------
+
+Please check README.devices for some notes and hints about device- or
+driver-specific issues to be aware of.
- http://sigrok.org/wiki/Linux
- http://sigrok.org/wiki/Mac_OS_X
- http://sigrok.org/wiki/Windows
- http://sigrok.org/wiki/FreeBSD
+Firmware
+--------
-Mailing lists
--------------
+Some devices supported by libsigrok need a firmware to be uploaded before the
+device can be used. See README.devices for details.
-There are two mailing lists for sigrok/libsigrok:
+
+Copyright and license
+---------------------
+
+libsigrok is licensed under the terms of the GNU General Public License
+(GPL), version 3 or later.
+
+While some individual source code files are licensed under the GPLv2+, and
+some files are licensed under the GPLv3+, this doesn't change the fact that
+the library as a whole is licensed under the terms of the GPLv3+.
+
+Please see the individual source files for the full list of copyright holders.
+
+
+Mailing list
+------------
https://lists.sourceforge.net/lists/listinfo/sigrok-devel
- https://lists.sourceforge.net/lists/listinfo/sigrok-commits
IRC
---
-You can find the sigrok developers in the #sigrok IRC channel on Freenode.
+You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
Website
-------
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrok
projects / libsigrok.git / blobdiff