README

   1 -------------------------------------------------------------------------------
   2 README
   3 -------------------------------------------------------------------------------
   4
   5 The sigrok project aims at creating a portable, cross-platform,
   6 Free/Libre/Open-Source signal analysis software suite that supports various
   7 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
   8
   9 PulseView is a Qt-based GUI for sigrok.
  10
  11
  12 Status
  13 ------
  14
  15 PulseView is currently work in progress. Some basic functionality
  16 is there, but it should still be considered alpha/beta stage software.
  17
  18 There have been no official tarball releases, yet.
  19
  20 Distro packagers should NOT package this, yet.
  21
  22
  23 Requirements
  24 ------------
  25
  26  - git
  27  - g++
  28  - make
  29  - libtool
  30  - pkg-config >= 0.22
  31  - cmake >= 2.6
  32  - libglib >= 2.28.0
  33  - Qt >= 4.5
  34  - libboost >= 1.42 (including the following libs):
  35     - libboost-system
  36     - libboost-thread
  37  - libsigrok >= 0.2.0
  38  - libsigrokdecode >= 0.1.0
  39
  40
  41 Building and installing
  42 -----------------------
  43
  44 In order to get the PulseView source code and build it, run:
  45
  46  $ git clone git://sigrok.org/pulseview
  47  $ cd pulseview
  48  $ cmake .
  49  $ make
  50
  51 For installing PulseView:
  52
  53  $ make install
  54
  55 Please see the following wiki pages for more detailed instructions:
  56
  57  http://sigrok.org/wiki/Linux
  58  http://sigrok.org/wiki/Mac_OS_X
  59  http://sigrok.org/wiki/Windows
  60  http://sigrok.org/wiki/FreeBSD
  61
  62
  63 Creating a source distribution package
  64 --------------------------------------
  65
  66 In order to build a source package begin with an unconfigured source tree.
  67
  68  $ mkdir dist
  69  $ cd dist
  70  $ cmake ..
  71  $ make package_source
  72
  73
  74 Mailing lists
  75 -------------
  76
  77 There are two mailing lists for sigrok/PulseView:
  78
  79  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  80  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  81
  82
  83 IRC
  84 ---
  85
  86 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  87
  88
  89 Website
  90 -------
  91
  92  http://sigrok.org/wiki/PulseView
  93