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).
39 - libusb-1.0 >= 1.0.9 (optional, used by most drivers)
40 - libftdi >= 0.16 (optional, used by some drivers)
41 - libudev >= 151 (optional, used by some drivers)
42 - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
43 - check >= 0.9.4 (optional, only needed to run unit tests)
46 Building and installing
47 -----------------------
49 In order to get the libsigrok source code and build it, run:
51 $ git clone git://sigrok.org/libsigrok
57 For installing libsigrok:
61 Please see the following wiki pages for more detailed instructions:
63 http://sigrok.org/wiki/Linux
64 http://sigrok.org/wiki/Mac_OS_X
65 http://sigrok.org/wiki/Windows
66 http://sigrok.org/wiki/FreeBSD
72 Some devices supported by libsigrok need a firmware to be uploaded before the
75 The default location where libsigrok expects the firmware files is:
77 $prefix/share/sigrok-firmware
79 ($prefix is usually /usr/local or /usr, depending on your ./configure options)
81 For further information see:
83 http://sigrok.org/wiki/Firmware
89 There are two mailing lists for sigrok/libsigrok:
91 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
92 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
98 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
104 http://sigrok.org/wiki/Libsigrok