| | 1 | ------------------------------------------------------------------------------- |
| | 2 | INSTALL |
| | 3 | ------------------------------------------------------------------------------- |
| | 4 | |
| | 5 | Requirements |
| | 6 | ------------ |
| | 7 | |
| | 8 | - git (only needed when building from git) |
| | 9 | - A C++ compiler with C++11 support (-std=c++11 option), e.g. |
| | 10 | - g++ (>= 4.8.1) |
| | 11 | - clang++ (>= 3.3) |
| | 12 | - make |
| | 13 | - libtool (only needed when building from git) |
| | 14 | - pkg-config >= 0.22 |
| | 15 | - cmake >= 2.8.12 |
| | 16 | - libglib >= 2.28.0 |
| | 17 | - glibmm-2.4 (>= 2.28.0) |
| | 18 | - Qt5 (including the following components): |
| | 19 | - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg |
| | 20 | - libboost >= 1.55 (including the following libs): |
| | 21 | - libboost-system |
| | 22 | - libboost-filesystem |
| | 23 | - libboost-serialization |
| | 24 | - libboost-test (optional, only needed to run the unit tests) |
| | 25 | - libboost-stacktrace (optional, only needed for debugging) |
| | 26 | - libsigrokcxx >= 0.5.1 (libsigrok C++ bindings) |
| | 27 | - libsigrokdecode >= 0.5.2 |
| | 28 | - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android) |
| | 29 | - asciidoctor (optional, only needed to build the HTML manual) |
| | 30 | - asciidoctor-pdf (optional, only needed to build the PDF manual) |
| | 31 | |
| | 32 | |
| | 33 | Building and installing |
| | 34 | ----------------------- |
| | 35 | |
| | 36 | In order to get the PulseView source code and build it, run: |
| | 37 | |
| | 38 | $ git clone git://sigrok.org/pulseview |
| | 39 | $ cd pulseview |
| | 40 | $ cmake . |
| | 41 | $ make |
| | 42 | |
| | 43 | For installing PulseView: |
| | 44 | |
| | 45 | $ make install |
| | 46 | |
| | 47 | See the following wiki page for more (OS-specific) instructions: |
| | 48 | |
| | 49 | http://sigrok.org/wiki/Building |
| | 50 | |
| | 51 | |
| | 52 | Creating a source distribution package |
| | 53 | -------------------------------------- |
| | 54 | |
| | 55 | In order to build a source package begin with an unconfigured source tree. |
| | 56 | |
| | 57 | $ mkdir dist |
| | 58 | $ cd dist |
| | 59 | $ cmake .. |
| | 60 | $ make package_source |
| | 61 | |
| | 62 | |
| | 63 | Generating the manual |
| | 64 | --------------------- |
| | 65 | |
| | 66 | To generate the HTML manual, you only need Asciidoctor. If you also want |
| | 67 | to generate the PDF manual, you need to install asciidoctor-pdf as well |
| | 68 | and make it available for execution: |
| | 69 | |
| | 70 | $ gem install --pre asciidoctor-pdf |
| | 71 | $ export PATH=~/.gem/ruby/2.3.0/bin:$PATH |
| | 72 | |
| | 73 | Then, to build the PulseView manual, run: |
| | 74 | |
| | 75 | $ make manual |
| | 76 | |
| | 77 | Note: The stylesheet used is a lightly modified version of "Read The Docs" |
| | 78 | from the Asciidoctor stylesheet factory: |
| | 79 | https://asciidoctor.org/docs/user-manual/#stylesheet-factory |
projects / pulseview.git / blame_incremental