X-Git-Url: http://git.code-monkey.de/?p=pulseview.git;a=blobdiff_plain;f=INSTALL;h=edb7940d522c9126e1edcbf8579e1d54fd2762f7;hp=075b18cedab5aa09a2ecf575409202c9f5418905;hb=0adee2d93430b5fb879388e66f3bd44fd11b3b22;hpb=e7ab88e3684b4a56a4c3854945371739cb5d9b5f

diff --git a/INSTALL b/INSTALL
index 075b18c..edb7940 100644
--- a/INSTALL
+++ b/INSTALL
@@ -7,12 +7,12 @@ Requirements
 
  - git (only needed when building from git)
  - A C++ compiler with C++11 support (-std=c++11 option), e.g.
-   - g++ (>= 4.7)
-   - clang++ (>= 3.1)
+   - g++ (>= 4.8.1)
+   - clang++ (>= 3.3)
  - make
  - libtool (only needed when building from git)
  - pkg-config >= 0.22
- - cmake >= 2.8.6
+ - cmake >= 2.8.12
  - libglib >= 2.28.0
  - glibmm-2.4 (>= 2.28.0)
  - Qt5 (including the following components):
@@ -22,9 +22,12 @@ 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)
+ - 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 +59,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