Session: Fix issue #67 by improving error handling

[pulseview.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index db85f73c6245df908568218f52ca30296c0ffc0e..e777959f83adf2b85806780ff70bd4ed6a2d6fbf 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,26 +5,31 @@ INSTALL
 Requirements
 ------------
 
- - git
+ - 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
+ - libtool (only needed when building from git)
  - pkg-config >= 0.22
- - cmake >= 2.8.6
+ - cmake >= 2.8.12
  - libglib >= 2.28.0
- - Qt4 >= 4.5 or Qt5 (including the following components):
-    - Qt4: QtCore, QtGui, QtSvg
-    - Qt5: Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg
- - libboost >= 1.42 (including the following libs):
+ - glibmm-2.4 (>= 2.28.0)
+ - 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-thread
+    - libboost-serialization
     - libboost-test (optional, only needed to run the unit tests)
- - libsigrokcxx >= 0.3.0 (libsigrok C++ bindings)
- - libsigrokdecode >= 0.3.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