]> sigrok.org Git - sigrok-cli.git/blame - README
CLI: properly feed SRD a sample number with every chunk of data.
[sigrok-cli.git] / README
CommitLineData
34c6b368
UH
1-------------------------------------------------------------------------------
2README
3-------------------------------------------------------------------------------
4
5The sigrok project aims at creating a portable, cross-platform,
6Free/Libre/Open-Source logic analyzer software that supports various
7logic analyzer hardware products.
8
9sigrok-cli is a command-line tool written in C, which uses both libsigrok
10and libsigrokdecode to provide the basic sigrok functionality from the
11command-line. Among other things, it's useful for scripting purposes.
12
13
14Status
15------
16
17The sigrok-cli project, while still in development, is pretty stable/usable.
18
19
20Requirements
21------------
22
23 - git
24 - gcc, g++, make, ...
25 - autoconf, automake, libtool, pkg-config
26 - libglib >= 2.22.0
27 - libsigrok
28 - libsigrokdecode
29
30
31Building and installing
32-----------------------
33
34In order to get the sigrok-cli source code and build it, run:
35
36 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
37 $ cd sigrok/sigrok-cli
38 $ ./autogen.sh
39 $ ./configure
40 $ make
41
42For installing sigrok-cli:
43
44 $ make install
45
46Please see the following wiki pages for more detailed instructions:
47
48 http://sigrok.org/wiki/Linux
49 http://sigrok.org/wiki/Mac_OS_X
50 http://sigrok.org/wiki/Windows
51 http://sigrok.org/wiki/FreeBSD
52
53
54Mailing lists
55-------------
56
57There are two mailing lists for sigrok/sigrok-cli:
58
59 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
60 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
61
62
63IRC
64---
65
66You can find the sigrok developers in the #sigrok IRC channel on Freenode.
67
68
69Website
70-------
71
72http://sigrok.org
73