1 -------------------------------------------------------------------------------
3 -------------------------------------------------------------------------------
8 - git (only needed when building from git)
9 - A C++ compiler with C++11 support (-std=c++11 option), e.g.
13 - libtool (only needed when building from git)
17 - glibmm-2.4 (>= 2.28.0)
18 - gstreamermm-1.0 (>= 1.8.0)
19 - Qt5 (>= 5.3), including the following components:
20 - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
21 - Qt translation package (at runtime, not build time)
22 - libboost >= 1.55 (including the following libs):
25 - libboost-serialization
26 - libboost-test (optional, only needed to run the unit tests)
27 - libboost-stacktrace (optional, only needed for debugging)
28 - libsigrokflow >= 0.1.0
29 - libsigrokcxx >= 0.5.1 (libsigrok C++ bindings)
30 - libsigrokdecode >= 0.6.0
31 - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
32 - asciidoctor (optional, only needed to build the HTML manual)
33 - asciidoctor-pdf (optional, only needed to build the PDF manual)
36 Building and installing
37 -----------------------
39 In order to get the PulseView source code and build it, run:
41 $ git clone git://sigrok.org/pulseview
46 For installing PulseView:
50 See the following wiki page for more (OS-specific) instructions:
52 http://sigrok.org/wiki/Building
55 Creating a source distribution package
56 --------------------------------------
58 In order to build a source package begin with an unconfigured source tree.
69 To generate the HTML manual, you only need Asciidoctor. If you also want
70 to generate the PDF manual, you need to install asciidoctor-pdf as well
71 and make it available for execution:
73 $ gem install --pre asciidoctor-pdf
74 $ export PATH=~/.gem/ruby/2.3.0/bin:$PATH
76 Then, to build the PulseView manual, run:
80 Note: The stylesheet used is a lightly modified version of "Read The Docs"
81 from the Asciidoctor stylesheet factory:
82 https://asciidoctor.org/docs/user-manual/#stylesheet-factory