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  - Qt5 (including the following components):
  19     - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
  20  - libboost >= 1.55 (including the following libs):
  21     - libboost-system
  22     - libboost-filesystem
  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 manual)
  30
  31
  32 Building and installing
  33 -----------------------
  34
  35 In order to get the PulseView source code and build it, run:
  36
  37  $ git clone git://sigrok.org/pulseview
  38  $ cd pulseview
  39  $ cmake .
  40  $ make
  41
  42 For installing PulseView:
  43
  44  $ make install
  45
  46 See the following wiki page for more (OS-specific) instructions:
  47
  48  http://sigrok.org/wiki/Building
  49
  50
  51 Creating a source distribution package
  52 --------------------------------------
  53
  54 In order to build a source package begin with an unconfigured source tree.
  55
  56  $ mkdir dist
  57  $ cd dist
  58  $ cmake ..
  59  $ make package_source
  60
  61
  62 Generating the manual
  63 ---------------------
  64
  65 To generate the HTML manual, you only need Asciidoctor. If you also want
  66 to generate the PDF manual, you need to install asciidoctor-pdf as well
  67 and make it available for execution:
  68
  69  $ gem install --pre asciidoctor-pdf
  70  $ export PATH=~/.gem/ruby/2.3.0/bin:$PATH
  71
  72 Then, to build the PulseView manual, run:
  73
  74  $ make manual
  75
  76 Note: The stylesheet used is a lightly modified version of "Read The Docs"
  77 from the Asciidoctor stylesheet factory:
  78 https://asciidoctor.org/docs/user-manual/#stylesheet-factory