X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=INSTALL;h=da89be8d014974312b214ecbe9192c937e556b55;hp=445e36b8e34561b5e91118a9a9f5a06d4f1abd92;hb=HEAD;hpb=e37a0c3e6087c1aaa1dff648ecb0c0d1ed786e6a

diff --git a/INSTALL b/INSTALL
index 445e36b8..e777959f 100644
--- a/INSTALL
+++ b/INSTALL
@@ -15,16 +15,21 @@ Requirements
  - cmake >= 2.8.12
  - libglib >= 2.28.0
  - glibmm-2.4 (>= 2.28.0)
- - Qt5 (including the following components):
-    - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
+ - Qt5 (>= 5.3), including the following components:
+    - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg,
+      Qt5LinguistTools (qttools5-dev, qttools5-dev-tools)
+    - Qt translation package (optional; needed at runtime, not build time)
  - libboost >= 1.55 (including the following libs):
     - libboost-system
     - libboost-filesystem
     - libboost-serialization
     - libboost-test (optional, only needed to run the unit tests)
- - libsigrokcxx >= 0.6.0 (libsigrok C++ bindings)
- - libsigrokdecode >= 0.6.0
+    - libboost-stacktrace (optional, only needed for debugging)
+ - libsigrokcxx >= 0.5.2 (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