INSTALL: Mention optional libboost-stacktrace.

[pulseview.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 95e0ae91803464cb7ed55beb3e7686a9295757b4..b51b246ebf3ea492a378f0cb762b5869e34909fe 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,19 +1,32 @@
+-------------------------------------------------------------------------------
+INSTALL
+-------------------------------------------------------------------------------
+
 Requirements
 ------------
 
- - git
- - g++
+ - git (only needed when building from git)
+ - A C++ compiler with C++11 support (-std=c++11 option), e.g.
+   - g++ (>= 4.8.1)
+   - clang++ (>= 3.3)
  - make
- - libtool
+ - libtool (only needed when building from git)
  - pkg-config >= 0.22
- - cmake >= 2.6
+ - cmake >= 2.8.12
  - libglib >= 2.28.0
- - Qt >= 4.5
- - libboost >= 1.42 (including the following libs):
+ - glibmm-2.4 (>= 2.28.0)
+ - Qt5 (including the following components):
+    - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
+ - libboost >= 1.55 (including the following libs):
     - libboost-system
-    - libboost-thread
- - libsigrok >= 0.2.0
- - libsigrokdecode >= 0.1.0
+    - 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.6.0
+ - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android)
+ - Asciidoctor (optional, only needed to build the manual)
 
 
 Building and installing
@@ -30,12 +43,9 @@ For installing PulseView:
 
  $ make install
 
-Please see the following wiki pages for more detailed instructions:
+See the following wiki page for more (OS-specific) instructions:
 
- http://sigrok.org/wiki/Linux
- http://sigrok.org/wiki/Mac_OS_X
- http://sigrok.org/wiki/Windows
- http://sigrok.org/wiki/FreeBSD
+ http://sigrok.org/wiki/Building
 
 
 Creating a source distribution package
@@ -47,3 +57,22 @@ In order to build a source package begin with an unconfigured source tree.
  $ cd dist
  $ 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