README/HACKING: Add/update GUI build info.
[sigrok:sigrok.git] / README
1 -------------------------------------------------------------------------------
2 README
3 -------------------------------------------------------------------------------
4
5 The sigrok project aims at creating a portable, cross-platform,
6 Free/Libre/Open-Source logic analyzer software that supports various
7 logic analyzer hardware products.
8
9 There are two shared libraries with common code, a command line utility for
10 basic usage and easy scriptability, as well as an intuitive GUI.
11
12
13 Status and API
14 --------------
15
16 The sigrok project is currently work in progress.
17
18 IMPORTANT: The API of the libraries is NOT yet considered stable! Please do
19            not rely on it, yet! Changes to function names, macro names etc.
20            can happen at any time without prior notice!
21
22
23 Requirements
24 ------------
25
26  - git
27  - gcc, g++, make, ...
28  - autoconf, automake, libtool, pkg-config
29  - libglib >= 2.22.0
30  - libusb >= 1.0.5 (for most logic analyzer hardware)
31  - libzip >= 0.8
32  - libftdi >= 0.16 (for some logic analyzer hardware)
33  - libudev >= 151 (for some logic analyzer hardware)
34  - Python >= 2.5 (for protocol decoders)
35  - Qt + Qt Creator >= 4.5 (for building/editing the GUI) 
36
37
38 Building and installing
39 -----------------------
40
41 In order to get the sigrok source code and build it, run:
42
43  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
44  $ cd sigrok
45  $ ./autogen.sh
46  $ ./configure
47  $ make
48
49 For building the Qt GUI:
50
51  $ cd gui
52  $ qmake
53  $ make
54
55 For building the GTK+ GUI:
56
57  TODO: Currently built automatically as part of the sigrok build.
58
59 NOTE: The GUIs are not yet usable, they're both work-in-progress!
60
61 For installing sigrok:
62
63  $ make install
64
65 Please see the following wiki pages for more detailed instructions:
66
67  http://sigrok.org/wiki/Linux
68  http://sigrok.org/wiki/Mac_OS_X
69  http://sigrok.org/wiki/Windows
70  http://sigrok.org/wiki/FreeBSD
71
72
73 Mailing lists
74 -------------
75
76 There are two mailing lists for sigrok:
77
78  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
79  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
80
81
82 IRC
83 ---
84
85 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
86
87
88 Website
89 -------
90
91 http://sigrok.org
92