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