]>
Commit | Line | Data |
---|---|---|
34c6b368 UH |
1 | ------------------------------------------------------------------------------- |
2 | README | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | The sigrok project aims at creating a portable, cross-platform, | |
31dde8ac | 6 | Free/Libre/Open-Source signal analysis software suite that supports various |
cdcf09f6 | 7 | device types (such as logic analyzers, oscilloscopes, multimeters, and more). |
34c6b368 UH |
8 | |
9 | sigrok-cli is a command-line tool written in C, which uses both libsigrok | |
10 | and libsigrokdecode to provide the basic sigrok functionality from the | |
11 | command-line. Among other things, it's useful for scripting purposes. | |
12 | ||
13 | ||
14 | Status | |
15 | ------ | |
16 | ||
cdcf09f6 | 17 | sigrok-cli is in a usable state and has had official tarball releases. |
34c6b368 UH |
18 | |
19 | ||
20 | Requirements | |
21 | ------------ | |
22 | ||
23 | - git | |
2658103e UH |
24 | - gcc |
25 | - make | |
26 | - autoconf >= 2.63 | |
27 | - automake >= 1.11 | |
28 | - libtool | |
29 | - pkg-config >= 0.22 | |
366237a3 | 30 | - libglib >= 2.28.0 |
6deff8e7 | 31 | - libsigrok >= 0.2.0 |
8c7940f1 | 32 | - libsigrokdecode >= 0.1.0 |
34c6b368 UH |
33 | |
34 | ||
35 | Building and installing | |
36 | ----------------------- | |
37 | ||
38 | In order to get the sigrok-cli source code and build it, run: | |
39 | ||
31dde8ac BV |
40 | $ git clone git://sigrok.org/sigrok-cli |
41 | $ cd sigrok-cli | |
34c6b368 UH |
42 | $ ./autogen.sh |
43 | $ ./configure | |
44 | $ make | |
45 | ||
46 | For installing sigrok-cli: | |
47 | ||
48 | $ make install | |
49 | ||
50 | Please see the following wiki pages for more detailed instructions: | |
51 | ||
52 | http://sigrok.org/wiki/Linux | |
53 | http://sigrok.org/wiki/Mac_OS_X | |
54 | http://sigrok.org/wiki/Windows | |
55 | http://sigrok.org/wiki/FreeBSD | |
56 | ||
57 | ||
58 | Mailing lists | |
59 | ------------- | |
60 | ||
61 | There are two mailing lists for sigrok/sigrok-cli: | |
62 | ||
63 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
64 | https://lists.sourceforge.net/lists/listinfo/sigrok-commits | |
65 | ||
66 | ||
67 | IRC | |
68 | --- | |
69 | ||
70 | You can find the sigrok developers in the #sigrok IRC channel on Freenode. | |
71 | ||
72 | ||
73 | Website | |
74 | ------- | |
75 | ||
cdcf09f6 | 76 | http://sigrok.org/wiki/Sigrok-cli |
34c6b368 | 77 |