Manual: Initial revision

[pulseview.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 445e36b8e34561b5e91118a9a9f5a06d4f1abd92..833db389b636890ab1526d41bcd6f94081cd8bd1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -25,6 +25,7 @@ Requirements
  - 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
@@ -56,3 +57,22 @@ 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:
+
+ $ cd manual
+ $ ./generate
+
+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