]>
Commit | Line | Data |
---|---|---|
13177edb UH |
1 | ------------------------------------------------------------------------------- |
2 | README | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | The sigrok project aims at creating a portable, cross-platform, | |
a5b2293f | 6 | Free/Libre/Open-Source signal analysis software suite that supports various |
4a1c927f | 7 | device types (such as logic analyzers, oscilloscopes, multimeters, and more). |
13177edb UH |
8 | |
9 | libsigrok is a shared library written in C which provides the basic API | |
a5b2293f BV |
10 | for talking to hardware and reading/writing the acquired data into various |
11 | input/output file formats. | |
13177edb UH |
12 | |
13 | ||
4a1c927f UH |
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 | ||
13177edb UH |
27 | Requirements |
28 | ------------ | |
29 | ||
30 | - git | |
1a081ca6 | 31 | - gcc (>= 4.0) |
ef7228ba UH |
32 | - make |
33 | - autoconf >= 2.63 | |
34 | - automake >= 1.11 | |
35 | - libtool | |
36 | - pkg-config >= 0.22 | |
406569dd | 37 | - libglib >= 2.32.0 |
8819bf5a | 38 | - libzip >= 0.10 |
330af0ec | 39 | - libserialport >= 0.1.0 (optional, used by some drivers) |
17e9317b | 40 | - libusb-1.0 >= 1.0.16 (optional, used by some drivers) |
294245ec | 41 | - libftdi >= 0.16 (optional, used by some drivers) |
7ab89f48 | 42 | - libudev >= 151 (optional, used by some drivers) |
294245ec | 43 | - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver) |
79bb0e97 | 44 | - check >= 0.9.4 (optional, only needed to run unit tests) |
13177edb UH |
45 | |
46 | ||
47 | Building and installing | |
48 | ----------------------- | |
49 | ||
50 | In order to get the libsigrok source code and build it, run: | |
51 | ||
a5b2293f BV |
52 | $ git clone git://sigrok.org/libsigrok |
53 | $ cd libsigrok | |
13177edb UH |
54 | $ ./autogen.sh |
55 | $ ./configure | |
56 | $ make | |
57 | ||
58 | For installing libsigrok: | |
59 | ||
60 | $ make install | |
61 | ||
ba642e86 | 62 | See INSTALL or the following wiki page for more (OS-specific) instructions: |
13177edb | 63 | |
ba642e86 | 64 | http://sigrok.org/wiki/Building |
13177edb UH |
65 | |
66 | ||
c77ed446 UH |
67 | Device-specific issues |
68 | ---------------------- | |
f9a33a47 | 69 | |
c77ed446 UH |
70 | Please check README.devices for some notes and hints about device- or |
71 | driver-specific issues to be aware of. | |
f9a33a47 | 72 | |
f9a33a47 | 73 | |
c77ed446 UH |
74 | Firmware |
75 | -------- | |
f9a33a47 | 76 | |
c77ed446 UH |
77 | Some devices supported by libsigrok need a firmware to be uploaded before the |
78 | device can be used. See README.devices for details. | |
f9a33a47 UH |
79 | |
80 | ||
6d036959 UH |
81 | Copyright and license |
82 | --------------------- | |
83 | ||
84 | libsigrok is licensed under the terms of the GNU General Public License | |
85 | (GPL), version 3 or later. | |
86 | ||
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+. | |
90 | ||
91 | Please see the individual source files for the full list of copyright holders. | |
92 | ||
93 | ||
13177edb UH |
94 | Mailing lists |
95 | ------------- | |
96 | ||
97 | There are two mailing lists for sigrok/libsigrok: | |
98 | ||
99 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
100 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
101 | ||
102 | ||
103 | IRC | |
104 | --- | |
105 | ||
106 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
107 | ||
108 | ||
109 | Website | |
110 | ------- | |
111 | ||
4a1c927f | 112 | http://sigrok.org/wiki/Libsigrok |
13177edb | 113 |