]>
Commit | Line | Data |
---|---|---|
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 | 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 | ||
14 | Status and API | |
15 | -------------- | |
16 | ||
17 | The libsigrokdecode project is currently work in progress. | |
18 | ||
19 | IMPORTANT: The API of libsigrokdecode 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 | The same applies for the API of the Python protocol decoders! | |
24 | ||
25 | ||
26 | Requirements | |
27 | ------------ | |
28 | ||
29 | - git | |
30 | - gcc, g++, make, ... | |
31 | - autoconf, automake, libtool, pkg-config | |
32 | - libglib >= 2.22.0 | |
33 | - Python >= 3.x (for protocol decoders) | |
34 | ||
35 | ||
36 | Building and installing | |
37 | ----------------------- | |
38 | ||
39 | In order to get the libsigrokdecode source code and build it, run: | |
40 | ||
41 | $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok | |
42 | $ cd sigrok/libsigrokdecode | |
43 | $ ./autogen.sh | |
44 | $ ./configure | |
45 | $ make | |
46 | ||
47 | For installing libsigrokdecode: | |
48 | ||
49 | $ make install | |
50 | ||
51 | Please see the following wiki pages for more detailed instructions: | |
52 | ||
53 | http://sigrok.org/wiki/Linux | |
54 | http://sigrok.org/wiki/Mac_OS_X | |
55 | http://sigrok.org/wiki/Windows | |
56 | http://sigrok.org/wiki/FreeBSD | |
57 | ||
58 | ||
59 | Mailing lists | |
60 | ------------- | |
61 | ||
62 | There are two mailing lists for sigrok/libsigrokdecode: | |
63 | ||
64 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
65 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
66 | ||
67 | ||
68 | IRC | |
69 | --- | |
70 | ||
71 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
72 | ||
73 | ||
74 | Website | |
75 | ------- | |
76 | ||
77 | http://sigrok.org | |
78 |