summaryrefslogtreecommitdiff
path: root/README
blob: 1ac8b42da76adbc46128b4cfdf438f1a3135ae09 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------

The sigrok project aims at creating a portable, cross-platform,
Free/Libre/Open-Source logic analyzer software that supports various
logic analyzer hardware products.

libsigrokdecode is a shared library written in C which provides the basic
API for running sigrok protocol decoders. The protocol decoders themselves
are written in Python.


Requirements
------------

 - git
 - gcc (>= 4.0)
 - make
 - autoconf >= 2.63
 - automake >= 1.11
 - libtool
 - pkg-config >= 0.22
 - libglib >= 2.22.0
 - Python >= 3.0


Building and installing
-----------------------

In order to get the libsigrokdecode source code and build it, run:

 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
 $ cd sigrok/libsigrokdecode
 $ ./autogen.sh
 $ ./configure
 $ make

For installing libsigrokdecode:

 $ make install

Please see the following wiki pages for more detailed instructions:

 http://sigrok.org/wiki/Linux
 http://sigrok.org/wiki/Mac_OS_X
 http://sigrok.org/wiki/Windows
 http://sigrok.org/wiki/FreeBSD


Mailing lists
-------------

There are two mailing lists for sigrok/libsigrokdecode:

 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
 https://lists.sourceforge.net/lists/listinfo/sigrok-commits


IRC
---

You can find the sigrok developers in the #sigrok IRC channel on Freenode.


Website
-------

http://sigrok.org