INSTALL: Mention optional libboost-stacktrace.

[pulseview.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 62cebc8333ab9b85434040647602995e92cb68fd..b51b246ebf3ea492a378f0cb762b5869e34909fe 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -22,9 +22,11 @@ Requirements
     - libboost-filesystem
     - libboost-serialization
     - libboost-test (optional, only needed to run the unit tests)
+    - libboost-stacktrace (optional, only needed for debugging)
  - libsigrokcxx >= 0.6.0 (libsigrok C++ bindings)
- - libsigrokdecode >= 0.5.0
+ - libsigrokdecode >= 0.6.0
  - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
+ - Asciidoctor (optional, only needed to build the manual)
 
 
 Building and installing
@@ -56,3 +58,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