]>
Commit | Line | Data |
---|---|---|
804404fc UH |
1 | ------------------------------------------------------------------------------- |
2 | README | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | The sigrok project aims at creating a portable, cross-platform, | |
d3b034e6 UH |
6 | Free/Libre/Open-Source signal analysis software suite that supports various |
7 | device types (such as logic analyzers, oscilloscopes, multimeters, and more). | |
804404fc UH |
8 | |
9 | libsigrokdecode is a shared library written in C which provides the basic | |
10 | API for running sigrok protocol decoders. The protocol decoders themselves | |
11 | are written in Python. | |
12 | ||
13 | ||
d3b034e6 UH |
14 | Status |
15 | ------ | |
16 | ||
17 | libsigrokdecode 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 | ||
804404fc UH |
27 | Requirements |
28 | ------------ | |
29 | ||
9177963d UH |
30 | - git (only needed when building from git) |
31 | - gcc (>= 4.0) or clang | |
066ecdab | 32 | - make |
9177963d UH |
33 | - autoconf >= 2.63 (only needed when building from git) |
34 | - automake >= 1.11 (only needed when building from git) | |
35 | - libtool (only needed when building from git) | |
066ecdab | 36 | - pkg-config >= 0.22 |
1a41642e | 37 | - libglib >= 2.34 |
a0a9afd9 | 38 | - Python >= 3.2 |
7529cdaa | 39 | - check >= 0.9.4 (optional, only needed to run unit tests) |
9177963d UH |
40 | - doxygen (optional, only needed for the C API docs) |
41 | - graphviz (optional, only needed for the C API docs) | |
804404fc UH |
42 | |
43 | ||
44 | Building and installing | |
45 | ----------------------- | |
46 | ||
47 | In order to get the libsigrokdecode source code and build it, run: | |
48 | ||
e0af499b UH |
49 | $ git clone git://sigrok.org/libsigrokdecode |
50 | $ cd libsigrokdecode | |
804404fc UH |
51 | $ ./autogen.sh |
52 | $ ./configure | |
53 | $ make | |
54 | ||
55 | For installing libsigrokdecode: | |
56 | ||
57 | $ make install | |
58 | ||
d5a4209d | 59 | See INSTALL or the following wiki page for more (OS-specific) instructions: |
804404fc | 60 | |
d5a4209d | 61 | http://sigrok.org/wiki/Building |
804404fc UH |
62 | |
63 | ||
3e1a99c0 UH |
64 | Copyright and license |
65 | --------------------- | |
66 | ||
67 | libsigrokdecode is licensed under the terms of the GNU General Public License | |
68 | (GPL), version 3 or later. | |
69 | ||
70 | The protocol decoders (PDs) included in libsigrokdecode are an integral part | |
71 | of the shared library (they are not merely external "plugins", they are not | |
72 | external programs that libsigrokdecode calls via fork/exec, they cannot | |
73 | function standalone without libsigrokdecode at all, the PDs and the rest of | |
74 | the libsigrokdecode codebase share data structures and make function calls | |
75 | to each other). Thus, since the PDs are part of the library, they are also | |
76 | licensed under the terms of the GPLv3+. | |
77 | ||
78 | While some individual source code files are licensed under the GPLv2+, and | |
79 | some files are licensed under the GPLv3+, this doesn't change the fact that | |
80 | the library as a whole is licensed under the terms of the GPLv3+. | |
81 | ||
82 | Please see the individual source files for the full list of copyright holders. | |
83 | ||
84 | ||
3b884e85 UH |
85 | Mailing list |
86 | ------------ | |
804404fc UH |
87 | |
88 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
804404fc UH |
89 | |
90 | ||
91 | IRC | |
92 | --- | |
93 | ||
0963cf62 | 94 | You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat. |
804404fc UH |
95 | |
96 | ||
97 | Website | |
98 | ------- | |
99 | ||
d3b034e6 | 100 | http://sigrok.org/wiki/Libsigrokdecode |
804404fc | 101 |