Add libsigrokflow build system integration.

[pulseview.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 32f388bc66d983e8fcdf31881c5cbfa41c99a6f5..7fb9f7305c1e152f9f76fb5f68165a9ca746ba4e 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -15,6 +15,7 @@ Requirements
  - cmake >= 2.8.12
  - libglib >= 2.28.0
  - glibmm-2.4 (>= 2.28.0)
+ - gstreamermm-1.0 (>= 1.8.0)
  - Qt5 (including the following components):
     - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
  - libboost >= 1.55 (including the following libs):
@@ -22,9 +23,13 @@ Requirements
     - libboost-filesystem
     - libboost-serialization
     - libboost-test (optional, only needed to run the unit tests)
- - libsigrokcxx >= 0.4.0 (libsigrok C++ bindings)
- - libsigrokdecode >= 0.4.0
+    - libboost-stacktrace (optional, only needed for debugging)
+ - libsigrokflow >= 0.1.0
+ - libsigrokcxx >= 0.5.1 (libsigrok C++ bindings)
+ - libsigrokdecode >= 0.5.2
  - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
+ - asciidoctor (optional, only needed to build the HTML manual)
+ - asciidoctor-pdf (optional, only needed to build the PDF manual)
 
 
 Building and installing
@@ -56,3 +61,21 @@ In order to build a source package begin with an unconfigured source tree.
  $ cmake ..
  $ make package_source
 
+
+Generating the manual
+---------------------
+
+To generate the HTML manual, you only need Asciidoctor. If you also want
+to generate the PDF manual, you need to install asciidoctor-pdf as well
+and make it available for execution:
+
+ $ gem install --pre asciidoctor-pdf
+ $ export PATH=~/.gem/ruby/2.3.0/bin:$PATH
+
+Then, to build the PulseView manual, run:
+
+ $ make manual
+
+Note: The stylesheet used is a lightly modified version of "Read The Docs"
+from the Asciidoctor stylesheet factory:
+https://asciidoctor.org/docs/user-manual/#stylesheet-factory