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