1 -------------------------------------------------------------------------------
3 -------------------------------------------------------------------------------
5 The sigrok project aims at creating a portable, cross-platform,
6 Free/Libre/Open-Source logic analyzer software that supports various
7 logic analyzer hardware products.
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 The libsigrokdecode project is currently work in progress.
19 IMPORTANT: The API of libsigrokdecode is NOT yet considered stable! Please do
20 not rely on it, yet! Changes to function names, macro names etc.
21 can happen at any time without prior notice!
23 The same applies for the API of the Python protocol decoders!
31 - autoconf, automake, libtool, pkg-config
33 - Python >= 3.x (for protocol decoders)
36 Building and installing
37 -----------------------
39 In order to get the libsigrokdecode source code and build it, run:
41 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
42 $ cd sigrok/libsigrokdecode
47 For installing libsigrokdecode:
51 Please see the following wiki pages for more detailed instructions:
53 http://sigrok.org/wiki/Linux
54 http://sigrok.org/wiki/Mac_OS_X
55 http://sigrok.org/wiki/Windows
56 http://sigrok.org/wiki/FreeBSD
62 There are two mailing lists for sigrok/libsigrokdecode:
64 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
65 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
71 You can find the sigrok developers in the #sigrok IRC channel on Freenode.