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