]>
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 | |
e21e8463 | 37 | - libglib >= 2.28.0 |
13177edb | 38 | - libzip >= 0.8 |
294245ec UH |
39 | - libusb-1.0 >= 1.0.9 (optional, used by most drivers) |
40 | - libftdi >= 0.16 (optional, used by some drivers) | |
41 | - libudev >= 151 (optional, used by some drivers) | |
42 | - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver) | |
79bb0e97 | 43 | - check >= 0.9.4 (optional, only needed to run unit tests) |
13177edb UH |
44 | |
45 | ||
46 | Building and installing | |
47 | ----------------------- | |
48 | ||
49 | In order to get the libsigrok source code and build it, run: | |
50 | ||
a5b2293f BV |
51 | $ git clone git://sigrok.org/libsigrok |
52 | $ cd libsigrok | |
13177edb UH |
53 | $ ./autogen.sh |
54 | $ ./configure | |
55 | $ make | |
56 | ||
57 | For installing libsigrok: | |
58 | ||
59 | $ make install | |
60 | ||
61 | Please see the following wiki pages for more detailed instructions: | |
62 | ||
63 | http://sigrok.org/wiki/Linux | |
64 | http://sigrok.org/wiki/Mac_OS_X | |
65 | http://sigrok.org/wiki/Windows | |
66 | http://sigrok.org/wiki/FreeBSD | |
67 | ||
68 | ||
c77ed446 UH |
69 | Device-specific issues |
70 | ---------------------- | |
f9a33a47 | 71 | |
c77ed446 UH |
72 | Please check README.devices for some notes and hints about device- or |
73 | driver-specific issues to be aware of. | |
f9a33a47 | 74 | |
f9a33a47 | 75 | |
c77ed446 UH |
76 | Firmware |
77 | -------- | |
f9a33a47 | 78 | |
c77ed446 UH |
79 | Some devices supported by libsigrok need a firmware to be uploaded before the |
80 | device can be used. See README.devices for details. | |
f9a33a47 UH |
81 | |
82 | ||
13177edb UH |
83 | Mailing lists |
84 | ------------- | |
85 | ||
86 | There are two mailing lists for sigrok/libsigrok: | |
87 | ||
88 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
89 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
90 | ||
91 | ||
92 | IRC | |
93 | --- | |
94 | ||
95 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
96 | ||
97 | ||
98 | Website | |
99 | ------- | |
100 | ||
4a1c927f | 101 | http://sigrok.org/wiki/Libsigrok |
13177edb | 102 |