]> sigrok.org Git - pulseview.git/blame - README
MinGW: Drop hardcoded BOOST_ROOT.
[pulseview.git] / README
CommitLineData
7a68af04
UH
1-------------------------------------------------------------------------------
2README
3-------------------------------------------------------------------------------
4
5The sigrok project aims at creating a portable, cross-platform,
6Free/Libre/Open-Source signal analysis software suite that supports various
7device types (such as logic analyzers, oscilloscopes, multimeters, and more).
8
9PulseView is a Qt-based GUI for sigrok.
10
11
12Status
13------
14
15PulseView is currently work in progress. Some basic functionality
16is there, but it should still be considered alpha/beta stage software.
17
18There have been no official tarball releases, yet.
19
20Distro packagers should NOT package this, yet.
21
22
23Requirements
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
06993d0c 34 - libboost >= 1.45 (including the following libs):
ae623051
UH
35 - libboost-system
36 - libboost-thread
7a68af04
UH
37 - libsigrok >= 0.2.0
38 - libsigrokdecode >= 0.1.0
39
40
41Building and installing
42-----------------------
43
44In order to get the PulseView source code and build it, run:
45
46 $ git clone git://sigrok.org/pulseview
47 $ cd pulseview
48 $ cmake .
49 $ make
50
51For installing PulseView:
52
53 $ make install
54
55Please see the following wiki pages for more detailed instructions:
56
57 http://sigrok.org/wiki/Linux
58 http://sigrok.org/wiki/Mac_OS_X
59 http://sigrok.org/wiki/Windows
60 http://sigrok.org/wiki/FreeBSD
61
c435f37f 62
202cf44d
JH
63Creating a source distribution package
64--------------------------------------
65
66In order to build a source package begin with an unconfigured source tree.
67
c435f37f
UH
68 $ mkdir dist
69 $ cd dist
70 $ cmake ..
71 $ make package_source
72
7a68af04
UH
73
74Mailing lists
75-------------
76
77There are two mailing lists for sigrok/PulseView:
78
79 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
80 https://lists.sourceforge.net/lists/listinfo/sigrok-commits
81
82
83IRC
84---
85
86You can find the sigrok developers in the #sigrok IRC channel on Freenode.
87
88
89Website
90-------
91
92 http://sigrok.org/wiki/PulseView
93