-------------------------------------------------------------------------------
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
+------
+
+libsigrokdecode is in a usable state and has had official tarball releases.
+
+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
------------
Website
-------
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrokdecode