Show relative time of flags on hover
[pulseview.git] / INSTALL
1 -------------------------------------------------------------------------------
2 INSTALL
3 -------------------------------------------------------------------------------
4
5 Requirements
6 ------------
7
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.8.1)
11    - clang++ (>= 3.3)
12  - make
13  - libtool (only needed when building from git)
14  - pkg-config >= 0.22
15  - cmake >= 2.8.12
16  - libglib >= 2.28.0
17  - glibmm-2.4 (>= 2.28.0)
18  - gstreamermm-1.0 (>= 1.8.0)
19  - Qt5 (including the following components):
20     - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
21  - libboost >= 1.55 (including the following libs):
22     - libboost-system
23     - libboost-filesystem
24     - libboost-serialization
25     - libboost-test (optional, only needed to run the unit tests)
26     - libboost-stacktrace (optional, only needed for debugging)
27  - libsigrokflow >= 0.1.0
28  - libsigrokcxx >= 0.5.1 (libsigrok C++ bindings)
29  - libsigrokdecode >= 0.6.0
30  - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
31  - asciidoctor (optional, only needed to build the HTML manual)
32  - asciidoctor-pdf (optional, only needed to build the PDF manual)
33
34
35 Building and installing
36 -----------------------
37
38 In order to get the PulseView source code and build it, run:
39
40  $ git clone git://sigrok.org/pulseview
41  $ cd pulseview
42  $ cmake .
43  $ make
44
45 For installing PulseView:
46
47  $ make install
48
49 See the following wiki page for more (OS-specific) instructions:
50
51  http://sigrok.org/wiki/Building
52
53
54 Creating a source distribution package
55 --------------------------------------
56
57 In order to build a source package begin with an unconfigured source tree.
58
59  $ mkdir dist
60  $ cd dist
61  $ cmake ..
62  $ make package_source
63
64
65 Generating the manual
66 ---------------------
67
68 To generate the HTML manual, you only need Asciidoctor. If you also want
69 to generate the PDF manual, you need to install asciidoctor-pdf as well
70 and make it available for execution:
71
72  $ gem install --pre asciidoctor-pdf
73  $ export PATH=~/.gem/ruby/2.3.0/bin:$PATH
74
75 Then, to build the PulseView manual, run:
76
77  $ make manual
78
79 Note: The stylesheet used is a lightly modified version of "Read The Docs"
80 from the Asciidoctor stylesheet factory:
81 https://asciidoctor.org/docs/user-manual/#stylesheet-factory