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 - Qt5 (including the following components):
19 - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
20 - libboost >= 1.55 (including the following libs):
23 - libboost-serialization
24 - libboost-test (optional, only needed to run the unit tests)
25 - libboost-stacktrace (optional, only needed for debugging)
26 - libsigrokcxx >= 0.5.1 (libsigrok C++ bindings)
27 - libsigrokdecode >= 0.5.2
28 - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
29 - asciidoctor (optional, only needed to build the HTML manual)
30 - asciidoctor-pdf (optional, only needed to build the PDF manual)
33 Building and installing
34 -----------------------
36 In order to get the PulseView source code and build it, run:
38 $ git clone git://sigrok.org/pulseview
43 For installing PulseView:
47 See the following wiki page for more (OS-specific) instructions:
49 http://sigrok.org/wiki/Building
52 Creating a source distribution package
53 --------------------------------------
55 In order to build a source package begin with an unconfigured source tree.
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:
70 $ gem install --pre asciidoctor-pdf
71 $ export PATH=~/.gem/ruby/2.3.0/bin:$PATH
73 Then, to build the PulseView manual, run:
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