Update README a bit.
[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 (usually USB-based) logic analyzer hardware products.
8
9 There will be a shared library 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 library 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  - libglib >= 2.0
27  - libusb >= 1.0.5
28  - libzip >= 0.8
29  - Python (for protocol decoder scripts)
30  - Qt + Qt Creator >= 4.5 (for building/editing the GUI) 
31
32
33 Building and installing
34 -----------------------
35
36 In order to get the sigrok source code and built it, run:
37
38  $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
39  $ cd sigrok
40  $ ./autogen.sh
41  $ make
42
43 For building the GUI:
44
45  $ cd frontend/gui
46  $ qmake
47  $ make
48
49 For installing sigrok:
50
51  $ make install
52
53 Please see the following wiki pages for more detailed instructions:
54
55  http://sigrok.org/wiki/Linux
56  http://sigrok.org/wiki/Mac_OS_X
57  http://sigrok.org/wiki/Windows
58
59
60 Mailing lists
61 -------------
62
63 There are two mailing lists for sigrok:
64
65  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
66  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
67
68
69 Website
70 -------
71
72 http://sigrok.org
73