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) |
| 5675292c | 18 | - Qt5 (>= 5.3), including the following components: |
| 01db382f UH |
19 | - Qt5Core, Qt5Gui, Qt5Widgets, Qt5Svg, Qt5LinguistTools |
| 20 | - Qt translation package (optional; needed at runtime, not build time) | |
| d68d75c2 | 21 | - libboost >= 1.55 (including the following libs): |
| dd3b0532 | 22 | - libboost-system |
| 7a2305bc | 23 | - libboost-filesystem |
| f8cbea47 | 24 | - libboost-serialization |
| e863bfad | 25 | - libboost-test (optional, only needed to run the unit tests) |
| 152a0b1b | 26 | - libboost-stacktrace (optional, only needed for debugging) |
| 1db57c03 | 27 | - libsigrokcxx >= 0.5.2 (libsigrok C++ bindings) |
| 9e633bf3 | 28 | - libsigrokdecode >= 0.5.2 |
| c3904ef7 | 29 | - libsigrokandroidutils >= 0.1.0 (optional, only needed on Android) |
| 11fa8979 UH |
30 | - asciidoctor (optional, only needed to build the HTML manual) |
| 31 | - asciidoctor-pdf (optional, only needed to build the PDF manual) | |
| dd3b0532 AG |
32 | |
| 33 | ||
| 34 | Building and installing | |
| 35 | ----------------------- | |
| 36 | ||
| 37 | In order to get the PulseView source code and build it, run: | |
| 38 | ||
| 39 | $ git clone git://sigrok.org/pulseview | |
| 40 | $ cd pulseview | |
| 41 | $ cmake . | |
| 42 | $ make | |
| 43 | ||
| 44 | For installing PulseView: | |
| 45 | ||
| 46 | $ make install | |
| 47 | ||
| a5331e7a | 48 | See the following wiki page for more (OS-specific) instructions: |
| dd3b0532 | 49 | |
| a5331e7a | 50 | http://sigrok.org/wiki/Building |
| dd3b0532 AG |
51 | |
| 52 | ||
| 53 | Creating a source distribution package | |
| 54 | -------------------------------------- | |
| 55 | ||
| 56 | In order to build a source package begin with an unconfigured source tree. | |
| 57 | ||
| 58 | $ mkdir dist | |
| 59 | $ cd dist | |
| 60 | $ cmake .. | |
| 61 | $ make package_source | |
| a5331e7a | 62 | |
| 1894027b SA |
63 | |
| 64 | Generating the manual | |
| 65 | --------------------- | |
| 66 | ||
| 67 | To generate the HTML manual, you only need Asciidoctor. If you also want | |
| 68 | to generate the PDF manual, you need to install asciidoctor-pdf as well | |
| 69 | and make it available for execution: | |
| 70 | ||
| 71 | $ gem install --pre asciidoctor-pdf | |
| 72 | $ export PATH=~/.gem/ruby/2.3.0/bin:$PATH | |
| 73 | ||
| 74 | Then, to build the PulseView manual, run: | |
| 75 | ||
| 3cec89a3 | 76 | $ make manual |
| 1894027b SA |
77 | |
| 78 | Note: The stylesheet used is a lightly modified version of "Read The Docs" | |
| 79 | from the Asciidoctor stylesheet factory: | |
| 80 | https://asciidoctor.org/docs/user-manual/#stylesheet-factory |