]> sigrok.org Git - libsigrok.git/blame - README
sr: Remove zlib dependency.
[libsigrok.git] / README
CommitLineData
13177edb
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
9libsigrok is a shared library written in C which provides the basic API
10for talking to logic analyzer hardware and reading/writing the acquired data
11into various input/output file formats.
12
13
13177edb
UH
14Requirements
15------------
16
17 - git
1a081ca6 18 - gcc (>= 4.0)
ef7228ba
UH
19 - make
20 - autoconf >= 2.63
21 - automake >= 1.11
22 - libtool
23 - pkg-config >= 0.22
13177edb
UH
24 - libglib >= 2.22.0
25 - libusb >= 1.0.5 (for most logic analyzer hardware)
26 - libzip >= 0.8
13177edb
UH
27 - libftdi >= 0.16 (for some logic analyzer hardware)
28 - libudev >= 151 (for some logic analyzer hardware)
29
30
31Building and installing
32-----------------------
33
34In order to get the libsigrok source code and build it, run:
35
36 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
37 $ cd sigrok/libsigrok
38 $ ./autogen.sh
39 $ ./configure
40 $ make
41
42For installing libsigrok:
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/libsigrok:
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