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 libsigrok is a shared library written in C which provides the basic API
  10 for talking to hardware and reading/writing the acquired data into various
  11 input/output file formats.
  12
  13
  14 Status
  15 ------
  16
  17 libsigrok is in a usable state and has had official tarball releases.
  18
  19 While the API can change from release to release, this will always be
  20 properly documented and reflected in the package version number and
  21 in the shared library / libtool / .so-file version numbers.
  22
  23 However, there are _NO_ guarantees at all for stable APIs in git snapshots!
  24 Distro packagers should only use released tarballs (no git snapshots).
  25
  26
  27 Requirements
  28 ------------
  29
  30  - git
  31  - gcc (>= 4.0)
  32  - make
  33  - autoconf >= 2.63
  34  - automake >= 1.11
  35  - libtool
  36  - pkg-config >= 0.22
  37  - libglib >= 2.28.0
  38  - libzip >= 0.8
  39  - libusb-1.0 >= 1.0.9 (optional, used by most drivers)
  40  - libftdi >= 0.16 (optional, used by some drivers)
  41  - libudev >= 151 (optional, used by some drivers)
  42  - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
  43  - check >= 0.9.4 (optional, only needed to run unit tests)
  44
  45
  46 Building and installing
  47 -----------------------
  48
  49 In order to get the libsigrok source code and build it, run:
  50
  51  $ git clone git://sigrok.org/libsigrok
  52  $ cd libsigrok
  53  $ ./autogen.sh
  54  $ ./configure
  55  $ make
  56
  57 For installing libsigrok:
  58
  59  $ make install
  60
  61 Please see the following wiki pages for more detailed instructions:
  62
  63  http://sigrok.org/wiki/Linux
  64  http://sigrok.org/wiki/Mac_OS_X
  65  http://sigrok.org/wiki/Windows
  66  http://sigrok.org/wiki/FreeBSD
  67
  68
  69 Firmware
  70 --------
  71
  72 Some devices supported by libsigrok need a firmware to be uploaded before the
  73 device can be used.
  74
  75 The default location where libsigrok expects the firmware files is:
  76
  77   $prefix/share/sigrok-firmware
  78
  79 ($prefix is usually /usr/local or /usr, depending on your ./configure options)
  80
  81 For further information see:
  82
  83   http://sigrok.org/wiki/Firmware
  84
  85
  86 Mailing lists
  87 -------------
  88
  89 There are two mailing lists for sigrok/libsigrok:
  90
  91  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  92  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  93
  94
  95 IRC
  96 ---
  97
  98 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  99
 100
 101 Website
 102 -------
 103
 104  http://sigrok.org/wiki/Libsigrok
 105