-------------------------------------------------------------------------------
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).
libsigrokdecode is a shared library written in C which provides the basic
API for running sigrok protocol decoders. The protocol decoders themselves
are written in Python.
-Status and API
---------------
+Status
+------
-The libsigrokdecode project is currently work in progress.
+libsigrokdecode is in a usable state and has had official tarball releases.
-IMPORTANT: The API of libsigrokdecode 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.
- The same applies for the API of the Python protocol decoders!
+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, g++, make, ...
- - autoconf, automake, libtool, pkg-config
- - libglib >= 2.22.0
- - Python >= 3.x (for protocol decoders)
+ - gcc (>= 4.0)
+ - make
+ - autoconf >= 2.63
+ - automake >= 1.11
+ - libtool
+ - pkg-config >= 0.22
+ - libglib >= 2.28.0
+ - Python >= 3.0
Building and installing
Website
-------
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrokdecode
projects / libsigrokdecode.git / blobdiff