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 libsigrok is a shared library written in C which provides the basic API
10 for talking to logic analyzer hardware and reading/writing the acquired data
11 into various input/output file formats.
17 libsigrok is currently work in progress.
19 IMPORTANT: The API of libsigrok 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!
35 - libusb >= 1.0.5 (for most logic analyzer hardware)
38 - libftdi >= 0.16 (for some logic analyzer hardware)
39 - libudev >= 151 (for some logic analyzer hardware)
42 Building and installing
43 -----------------------
45 In order to get the libsigrok source code and build it, run:
47 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
53 For installing libsigrok:
57 Please see the following wiki pages for more detailed instructions:
59 http://sigrok.org/wiki/Linux
60 http://sigrok.org/wiki/Mac_OS_X
61 http://sigrok.org/wiki/Windows
62 http://sigrok.org/wiki/FreeBSD
68 There are two mailing lists for sigrok/libsigrok:
70 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
71 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
77 You can find the sigrok developers in the #sigrok IRC channel on Freenode.