kingst-la2016: fix segfault that often occurs when a capture is aborted
[libsigrok.git] / README
1 -------------------------------------------------------------------------------
2 README
3 -------------------------------------------------------------------------------
4
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).
8
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.
12
13
14 Status
15 ------
16
17 libsigrok is in a usable state and has had official tarball releases.
18
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.
22
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).
25
26
27 Requirements
28 ------------
29
30 Requirements for the C library:
31
32  - git (only needed when building from git)
33  - gcc (>= 4.0) or clang
34  - make
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)
38  - pkg-config >= 0.22
39  - libglib >= 2.32.0
40  - libzip >= 0.10
41  - libtirpc (optional, used by VXI, fallback when glibc >= 2.26)
42  - libserialport >= 0.1.1 (optional, used by some drivers)
43  - librevisa >= 0.0.20130412 (optional, used by some drivers)
44  - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
45  - hidapi >= 0.8.0 (optional, used for some HID based "serial cables")
46  - bluez/libbluetooth >= 4.0 (optional, used for Bluetooth/BLE communication)
47  - libftdi1 >= 1.0 (optional, used by some drivers)
48  - libgpib (optional, used by some drivers)
49  - libieee1284 (optional, used by some drivers)
50  - libgio >= 2.32.0 (optional, used by some drivers)
51  - check >= 0.9.4 (optional, only needed to run unit tests)
52  - doxygen (optional, only needed for the C API docs)
53  - graphviz (optional, only needed for the C API docs)
54
55 Requirements for the C++ bindings:
56
57  - libsigrok >= 0.4.0 (the libsigrok C library, see above)
58  - A C++ compiler with C++11 support (-std=c++11 option), e.g.
59    - g++ (>= 4.8.1)
60    - clang++ (>= 3.3)
61  - autoconf-archive (only needed when building from git)
62  - doxygen (required for building the bindings, not only for C++ API docs!)
63  - graphviz (optional, only needed for the C++ API docs)
64  - Python (2 or 3) executable (development files are not needed)
65  - glibmm-2.4 (>= 2.32.0)
66
67 Requirements for the Python bindings:
68
69  - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
70  - Python >= 2.7 or Python >= 3 (including development files!)
71  - Python setuptools (for Python 2 or 3)
72  - pygobject >= 3.0.0 (for Python 2 or 3), a.k.a python-gi
73  - numpy (for Python 2 or 3)
74  - SWIG >= 2.0.0
75  - doxygen (optional, only needed for the Python API docs)
76  - graphviz (optional, only needed for the Python API docs)
77  - doxypy (optional, only needed for the Python API docs)
78
79 Requirements for the Ruby bindings:
80
81  - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
82  - Ruby >= 2.5.0 (including development files!)
83  - SWIG >= 3.0.8
84  - YARD (optional, only needed for the Ruby API docs)
85
86 Requirements for the Java bindings:
87
88  - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above)
89  - SWIG >= 2.0.0
90  - Java JDK (for JNI includes and the javac/jar binaries)
91  - doxygen (optional, only needed for the Java API docs)
92  - graphviz (optional, only needed for the Java API docs)
93
94
95 Building and installing
96 -----------------------
97
98 In order to get the libsigrok source code and build it, run:
99
100  $ git clone git://sigrok.org/libsigrok
101  $ cd libsigrok
102  $ ./autogen.sh
103  $ ./configure
104  $ make
105
106 For installing libsigrok:
107
108  $ make install
109
110 See INSTALL or the following wiki page for more (OS-specific) instructions:
111
112  http://sigrok.org/wiki/Building
113
114 Please also check the following wiki page in case you encounter any issues:
115
116  http://sigrok.org/wiki/Building#FAQ
117
118
119 Device-specific issues
120 ----------------------
121
122 Please check README.devices for some notes and hints about device- or
123 driver-specific issues to be aware of.
124
125
126 Firmware
127 --------
128
129 Some devices supported by libsigrok need a firmware to be uploaded before the
130 device can be used. See README.devices for details.
131
132
133 Copyright and license
134 ---------------------
135
136 libsigrok is licensed under the terms of the GNU General Public License
137 (GPL), version 3 or later.
138
139 While some individual source code files are licensed under the GPLv2+, and
140 some files are licensed under the GPLv3+, this doesn't change the fact that
141 the library as a whole is licensed under the terms of the GPLv3+.
142
143 Please see the individual source files for the full list of copyright holders.
144
145
146 Mailing list
147 ------------
148
149  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
150
151
152 IRC
153 ---
154
155 You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat.
156
157
158 Website
159 -------
160
161  http://sigrok.org/wiki/Libsigrok
162