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 - libserialport >= 0.1.0 (optional, used by some drivers)
40 - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
41 - libftdi >= 0.16 (optional, used by some drivers)
42 - libudev >= 151 (optional, used by some drivers)
43 - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
44 - check >= 0.9.4 (optional, only needed to run unit tests)
47 Building and installing
48 -----------------------
50 In order to get the libsigrok source code and build it, run:
52 $ git clone git://sigrok.org/libsigrok
58 For installing libsigrok:
62 See INSTALL or the following wiki page for more (OS-specific) instructions:
64 http://sigrok.org/wiki/Building
67 Device-specific issues
68 ----------------------
70 Please check README.devices for some notes and hints about device- or
71 driver-specific issues to be aware of.
77 Some devices supported by libsigrok need a firmware to be uploaded before the
78 device can be used. See README.devices for details.
84 libsigrok is licensed under the terms of the GNU General Public License
85 (GPL), version 3 or later.
87 While some individual source code files are licensed under the GPLv2+, and
88 some files are licensed under the GPLv3+, this doesn't change the fact that
89 the library as a whole is licensed under the terms of the GPLv3+.
91 Please see the individual source files for the full list of copyright holders.
97 There are two mailing lists for sigrok/libsigrok:
99 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
100 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
106 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
112 http://sigrok.org/wiki/Libsigrok