Use static signal offsets instead of offsets calculated on-the-fly
[pulseview.git] / README
1 -------------------------------------------------------------------------------
2 README
3 -------------------------------------------------------------------------------
4
5 The sigrok project aims at creating a portable, cross-platform,
6 Free/Libre/Open-Source signal analysis software suite that supports various
7 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
8
9 PulseView is a Qt-based GUI for sigrok.
10
11
12 Status
13 ------
14
15 PulseView is currently work in progress. Some basic functionality
16 is there, but it should still be considered alpha/beta stage software.
17
18 There have been no official tarball releases, yet.
19
20 Distro packagers should NOT package this, yet.
21
22
23 Requirements
24 ------------
25
26  - git
27  - g++
28  - make
29  - libtool
30  - pkg-config >= 0.22
31  - cmake >= 2.6
32  - libglib >= 2.28.0
33  - Qt >= 4.5
34  - libboost >= 1.46
35  - libsigrok >= 0.2.0
36  - libsigrokdecode >= 0.1.0
37
38
39 Building and installing
40 -----------------------
41
42 In order to get the PulseView source code and build it, run:
43
44  $ git clone git://sigrok.org/pulseview
45  $ cd pulseview
46  $ cmake .
47  $ make
48
49 For installing PulseView:
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  http://sigrok.org/wiki/FreeBSD
59
60
61 Mailing lists
62 -------------
63
64 There are two mailing lists for sigrok/PulseView:
65
66  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
67  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
68
69
70 IRC
71 ---
72
73 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
74
75
76 Website
77 -------
78
79  http://sigrok.org/wiki/PulseView
80