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 libsigrok is a shared library written in C which provides the basic API
10 for talking to hardware and reading/writing the acquired data into various
11 input/output file formats.
17 libsigrok 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).
38 - libusb >= 1.0.5 (for most hardware)
40 - libftdi >= 0.16 (for some hardware)
41 - libudev >= 151 (for some hardware)
44 Building and installing
45 -----------------------
47 In order to get the libsigrok source code and build it, run:
49 $ git clone git://sigrok.org/libsigrok
55 For installing libsigrok:
59 Please see the following wiki pages for more detailed instructions:
61 http://sigrok.org/wiki/Linux
62 http://sigrok.org/wiki/Mac_OS_X
63 http://sigrok.org/wiki/Windows
64 http://sigrok.org/wiki/FreeBSD
70 Some devices supported by libsigrok need a firmware to be uploaded before the
73 The default location where libsigrok expects the firmware files is:
75 $prefix/share/sigrok-firmware
77 ($prefix is usually /usr/local or /usr, depending on your ./configure options)
79 For further information see:
81 http://sigrok.org/wiki/Firmware
87 There are two mailing lists for sigrok/libsigrok:
89 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
90 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
96 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
102 http://sigrok.org/wiki/Libsigrok