Minor whitespace and Doxygen fixes.
[pulseview.git] / INSTALL
blob42cc79b5f6312d3e4a67068e3fe80cc9e4e32c0a
1 -------------------------------------------------------------------------------
2 INSTALL
3 -------------------------------------------------------------------------------
5 Requirements
6 ------------
8  - git (only needed when building from git)
9  - A C++ compiler with C++11 support (-std=c++11 option), e.g.
10    - g++ (>= 4.7)
11    - clang++ (>= 3.1)
12  - make
13  - libtool (only needed when building from git)
14  - pkg-config >= 0.22
15  - cmake >= 2.8.6
16  - libglib >= 2.28.0
17  - Qt4 >= 4.5 or Qt5 (including the following components):
18     - Qt4: QtCore, QtGui, QtSvg
19     - Qt5: Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
20  - libboost >= 1.48 (including the following libs):
21     - libboost-system
22     - libboost-filesystem
23     - libboost-thread
24     - libboost-test (optional, only needed to run the unit tests)
25  - libsigrokcxx >= 0.4.0 (libsigrok C++ bindings)
26  - libsigrokdecode >= 0.4.0
27  - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
30 Building and installing
31 -----------------------
33 In order to get the PulseView source code and build it, run:
35  $ git clone git://sigrok.org/pulseview
36  $ cd pulseview
37  $ cmake .
38  $ make
40 For installing PulseView:
42  $ make install
44 See the following wiki page for more (OS-specific) instructions:
46  http://sigrok.org/wiki/Building
49 Creating a source distribution package
50 --------------------------------------
52 In order to build a source package begin with an unconfigured source tree.
54  $ mkdir dist
55  $ cd dist
56  $ cmake ..
57  $ make package_source