]> sigrok.org Git - libsigrok.git/blame - README
sr/srd: Remove API warnings from READMEs.
[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
27 - zlib >= 1.2.3.1
28 - libftdi >= 0.16 (for some logic analyzer hardware)
29 - libudev >= 151 (for some logic analyzer hardware)
30
31
32Building and installing
33-----------------------
34
35In order to get the libsigrok source code and build it, run:
36
37 $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
38 $ cd sigrok/libsigrok
39 $ ./autogen.sh
40 $ ./configure
41 $ make
42
43For installing libsigrok:
44
45 $ make install
46
47Please see the following wiki pages for more detailed instructions:
48
49 http://sigrok.org/wiki/Linux
50 http://sigrok.org/wiki/Mac_OS_X
51 http://sigrok.org/wiki/Windows
52 http://sigrok.org/wiki/FreeBSD
53
54
55Mailing lists
56-------------
57
58There are two mailing lists for sigrok/libsigrok:
59
60 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
61 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
62
63
64IRC
65---
66
67You can find the sigrok developers in the #sigrok IRC channel on Freenode.
68
69
70Website
71-------
72
73http://sigrok.org
74