]>
Commit | Line | Data |
---|---|---|
13177edb UH |
1 | ------------------------------------------------------------------------------- |
2 | README | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | The sigrok project aims at creating a portable, cross-platform, | |
6 | Free/Libre/Open-Source logic analyzer software that supports various | |
7 | logic analyzer hardware products. | |
8 | ||
9 | libsigrok is a shared library written in C which provides the basic API | |
10 | for talking to logic analyzer hardware and reading/writing the acquired data | |
11 | into various input/output file formats. | |
12 | ||
13 | ||
14 | Status and API | |
15 | -------------- | |
16 | ||
17 | libsigrok is currently work in progress. | |
18 | ||
19 | IMPORTANT: The API of libsigrok is NOT yet considered stable! Please do | |
20 | not rely on it, yet! Changes to function names, macro names etc. | |
21 | can happen at any time without prior notice! | |
22 | ||
23 | ||
24 | Requirements | |
25 | ------------ | |
26 | ||
27 | - git | |
28 | - gcc, g++, make, ... | |
29 | - autoconf, automake, libtool, pkg-config | |
30 | - libglib >= 2.22.0 | |
31 | - libusb >= 1.0.5 (for most logic analyzer hardware) | |
32 | - libzip >= 0.8 | |
33 | - zlib >= 1.2.3.1 | |
34 | - libftdi >= 0.16 (for some logic analyzer hardware) | |
35 | - libudev >= 151 (for some logic analyzer hardware) | |
36 | ||
37 | ||
38 | Building and installing | |
39 | ----------------------- | |
40 | ||
41 | In order to get the libsigrok source code and build it, run: | |
42 | ||
43 | $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok | |
44 | $ cd sigrok/libsigrok | |
45 | $ ./autogen.sh | |
46 | $ ./configure | |
47 | $ make | |
48 | ||
49 | For installing libsigrok: | |
50 | ||
51 | $ make install | |
52 | ||
53 | Please see the following wiki pages for more detailed instructions: | |
54 | ||
55 | http://sigrok.org/wiki/Linux | |
56 | http://sigrok.org/wiki/Mac_OS_X | |
57 | http://sigrok.org/wiki/Windows | |
58 | http://sigrok.org/wiki/FreeBSD | |
59 | ||
60 | ||
61 | Mailing lists | |
62 | ------------- | |
63 | ||
64 | There are two mailing lists for sigrok/libsigrok: | |
65 | ||
66 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
67 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
68 | ||
69 | ||
70 | IRC | |
71 | --- | |
72 | ||
73 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
74 | ||
75 | ||
76 | Website | |
77 | ------- | |
78 | ||
79 | http://sigrok.org | |
80 |