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).
30 Requirements for the C library:
32 - git (only needed when building from git)
33 - gcc (>= 4.0) or clang
35 - autoconf >= 2.63 (only needed when building from git)
36 - automake >= 1.11 (only needed when building from git)
37 - libtool (only needed when building from git)
41 - libserialport >= 0.1.1 (optional, used by some drivers)
42 - librevisa >= 0.0.20130412 (optional, used by some drivers)
43 - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
44 - libftdi >= 0.16 or libftdi1 >= 1.0 (optional, used by some drivers)
45 - libgpib (optional, used by some drivers)
46 - check >= 0.9.4 (optional, only needed to run unit tests)
47 - doxygen (optional, only needed for the C API docs)
48 - graphviz (optional, only needed for the C API docs)
50 Requirements for the C++ bindings:
52 - libsigrok >= 0.3.0 (the libsigrok C library, see above)
53 - A C++ compiler with C++11 support (-std=c++11 option), e.g.
56 - autoconf-archive (only needed when building from git)
57 - doxygen (required for building the bindings, not only for C++ API docs!)
58 - graphviz (optional, only needed for the C++ API docs)
59 - Python (2 or 3) executable (development files are not needed)
60 - glibmm-2.4 (>= 2.32.0)
62 Requirements for the Python bindings:
64 - libsigrokcxx >= 0.3.0 (the libsigrok C++ bindings, see above)
65 - Python >= 2.7 or Python >= 3 (including development files!)
66 - Python setuptools (for Python 2 or 3)
67 - pygobject >= 3.0.0 (for Python 2 or 3), a.k.a python-gi
68 - numpy (for Python 2 or 3)
70 - doxygen (optional, only needed for the Python API docs)
71 - graphviz (optional, only needed for the Python API docs)
72 - doxypy (optional, only needed for the Python API docs)
74 Requirements for the Ruby bindings:
76 - libsigrokcxx >= 0.3.0 (the libsigrok C++ bindings, see above)
77 - Ruby >= 1.9.3 (including development files!)
79 - YARD (optional, only needed for the Ruby API docs)
81 Requirements for the Java bindings:
83 - libsigrokcxx >= 0.3.0 (the libsigrok C++ bindings, see above)
85 - Java JDK (for JNI includes and the javac/jar binaries)
86 - doxygen (optional, only needed for the Java API docs)
87 - graphviz (optional, only needed for the Java API docs)
90 Building and installing
91 -----------------------
93 In order to get the libsigrok source code and build it, run:
95 $ git clone git://sigrok.org/libsigrok
101 For installing libsigrok:
105 See INSTALL or the following wiki page for more (OS-specific) instructions:
107 http://sigrok.org/wiki/Building
109 Please also check the following wiki page in case you encounter any issues:
111 http://sigrok.org/wiki/Building#FAQ
114 Device-specific issues
115 ----------------------
117 Please check README.devices for some notes and hints about device- or
118 driver-specific issues to be aware of.
124 Some devices supported by libsigrok need a firmware to be uploaded before the
125 device can be used. See README.devices for details.
128 Copyright and license
129 ---------------------
131 libsigrok is licensed under the terms of the GNU General Public License
132 (GPL), version 3 or later.
134 While some individual source code files are licensed under the GPLv2+, and
135 some files are licensed under the GPLv3+, this doesn't change the fact that
136 the library as a whole is licensed under the terms of the GPLv3+.
138 Please see the individual source files for the full list of copyright holders.
144 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
150 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
156 http://sigrok.org/wiki/Libsigrok