X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=INSTALL;h=833db389b636890ab1526d41bcd6f94081cd8bd1;hp=904855816b6b282301e0c742e22c0a9b7ebd8af7;hb=39dce56b0e0b4daba503663e44ee6c86a754ddc2;hpb=06ef804f11e4e0213013e7729f43ebde529fca48 diff --git a/INSTALL b/INSTALL index 90485581..833db389 100644 --- a/INSTALL +++ b/INSTALL @@ -7,24 +7,25 @@ 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 - - Qt4 >= 4.5 or Qt5 (including the following components): - - Qt4: QtCore, QtGui, QtSvg - - Qt5: Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg - - libboost >= 1.53 (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-filesystem - - libboost-thread + - libboost-serialization - libboost-test (optional, only needed to run the unit tests) - - libsigrokcxx >= 0.4.0 (libsigrok C++ bindings) - - libsigrokdecode >= 0.4.0 + - 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