1 -------------------------------------------------------------------------------
3 -------------------------------------------------------------------------------
5 The sigrok project aims at creating a portable, cross-platform,
6 Free/Libre/Open-Source signal analysis software suite that supports various
7 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
9 libsigrokdecode is a shared library written in C which provides the basic
10 API for running sigrok protocol decoders. The protocol decoders themselves
11 are written in Python.
17 libsigrokdecode is in a usable state and has had official tarball releases.
19 While the API can change from release to release, this will always be
20 properly documented and reflected in the package version number and
21 in the shared library / libtool / .so-file version numbers.
23 However, there are _NO_ guarantees at all for stable APIs in git snapshots!
24 Distro packagers should only use released tarballs (no git snapshots).
41 Building and installing
42 -----------------------
44 In order to get the libsigrokdecode source code and build it, run:
46 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
47 $ cd sigrok/libsigrokdecode
52 For installing libsigrokdecode:
56 Please see the following wiki pages for more detailed instructions:
58 http://sigrok.org/wiki/Linux
59 http://sigrok.org/wiki/Mac_OS_X
60 http://sigrok.org/wiki/Windows
61 http://sigrok.org/wiki/FreeBSD
67 There are two mailing lists for sigrok/libsigrokdecode:
69 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
70 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
76 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
82 http://sigrok.org/wiki/Libsigrokdecode