]>
Commit | Line | Data |
---|---|---|
13177edb UH |
1 | ------------------------------------------------------------------------------- |
2 | README | |
3 | ------------------------------------------------------------------------------- | |
f1b296fc BV |
4 | libsigrok4DSLogic is a shared library which provides the basic API |
5 | for DSLogic hardware. | |
6 | libsigrok4DSLogic is based on libsigrok, a shared library from the sigrok project. | |
13177edb UH |
7 | |
8 | The sigrok project aims at creating a portable, cross-platform, | |
a5b2293f | 9 | Free/Libre/Open-Source signal analysis software suite that supports various |
4a1c927f | 10 | device types (such as logic analyzers, oscilloscopes, multimeters, and more). |
13177edb UH |
11 | |
12 | libsigrok is a shared library written in C which provides the basic API | |
a5b2293f BV |
13 | for talking to hardware and reading/writing the acquired data into various |
14 | input/output file formats. | |
13177edb UH |
15 | |
16 | ||
4a1c927f UH |
17 | Status |
18 | ------ | |
19 | ||
20 | libsigrok is in a usable state and has had official tarball releases. | |
21 | ||
22 | While the API can change from release to release, this will always be | |
23 | properly documented and reflected in the package version number and | |
24 | in the shared library / libtool / .so-file version numbers. | |
25 | ||
26 | However, there are _NO_ guarantees at all for stable APIs in git snapshots! | |
27 | Distro packagers should only use released tarballs (no git snapshots). | |
28 | ||
29 | ||
13177edb UH |
30 | Requirements |
31 | ------------ | |
32 | ||
33 | - git | |
1a081ca6 | 34 | - gcc (>= 4.0) |
ef7228ba UH |
35 | - make |
36 | - autoconf >= 2.63 | |
37 | - automake >= 1.11 | |
38 | - libtool | |
39 | - pkg-config >= 0.22 | |
406569dd | 40 | - libglib >= 2.32.0 |
13177edb | 41 | - libzip >= 0.8 |
294245ec UH |
42 | - libusb-1.0 >= 1.0.9 (optional, used by most drivers) |
43 | - libftdi >= 0.16 (optional, used by some drivers) | |
294245ec | 44 | - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver) |
79bb0e97 | 45 | - check >= 0.9.4 (optional, only needed to run unit tests) |
13177edb UH |
46 | |
47 | ||
48 | Building and installing | |
49 | ----------------------- | |
f1b296fc BV |
50 | Get the libsigrok4DSLogic source code from: www.dreamsourcelab.com/download.html |
51 | In order to build it, run: | |
13177edb | 52 | |
a5b2293f | 53 | $ cd libsigrok |
13177edb UH |
54 | $ ./autogen.sh |
55 | $ ./configure | |
56 | $ make | |
57 | ||
f1b296fc | 58 | For installing libsigrok4DSLogic: |
13177edb UH |
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 | ||
6d036959 UH |
67 | Copyright and license |
68 | --------------------- | |
69 | ||
f1b296fc | 70 | libsigrok4DSLogic is licensed under the terms of the GNU General Public License |
6d036959 UH |
71 | (GPL), version 3 or later. |
72 | ||
73 | While some individual source code files are licensed under the GPLv2+, and | |
74 | some files are licensed under the GPLv3+, this doesn't change the fact that | |
75 | the library as a whole is licensed under the terms of the GPLv3+. | |
76 | ||
77 | Please see the individual source files for the full list of copyright holders. | |
78 | ||
79 | ||
13177edb UH |
80 | Mailing lists |
81 | ------------- | |
82 | ||
83 | There are two mailing lists for sigrok/libsigrok: | |
84 | ||
85 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
86 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
87 | ||
88 | ||
89 | IRC | |
90 | --- | |
91 | ||
92 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
93 | ||
94 | ||
95 | Website | |
96 | ------- | |
97 | ||
4a1c927f | 98 | http://sigrok.org/wiki/Libsigrok |
f1b296fc | 99 | http://dreamsourcelab.com |
13177edb | 100 |