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.32.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  - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
  42  - check >= 0.9.4 (optional, only needed to run unit tests)
  43
  44
  45 Building and installing
  46 -----------------------
  47
  48 In order to get the libsigrok source code and build it, run:
  49
  50  $ git clone git://sigrok.org/libsigrok
  51  $ cd libsigrok
  52  $ ./autogen.sh
  53  $ ./configure
  54  $ make
  55
  56 For installing libsigrok:
  57
  58  $ make install
  59
  60 See INSTALL or the following wiki page for more (OS-specific) instructions:
  61
  62  http://sigrok.org/wiki/Building
  63
  64
  65 Device-specific issues
  66 ----------------------
  67
  68 Please check README.devices for some notes and hints about device- or
  69 driver-specific issues to be aware of.
  70
  71
  72 Firmware
  73 --------
  74
  75 Some devices supported by libsigrok need a firmware to be uploaded before the
  76 device can be used. See README.devices for details.
  77
  78
  79 Mailing lists
  80 -------------
  81
  82 There are two mailing lists for sigrok/libsigrok:
  83
  84  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  85  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  86
  87
  88 IRC
  89 ---
  90
  91 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  92
  93
  94 Website
  95 -------
  96
  97  http://sigrok.org/wiki/Libsigrok
  98