README

   1 -------------------------------------------------------------------------------
   2 README
   3 -------------------------------------------------------------------------------
   4 libsigrok4DSLogic is a shared library which provides the basic API
   5 for DSLogic hardware.
   6 libsigrok4DSLogic is based on libsigrok, a shared library from the sigrok project.
   7
   8 The sigrok project aims at creating a portable, cross-platform,
   9 Free/Libre/Open-Source signal analysis software suite that supports various
  10 device types (such as logic analyzers, oscilloscopes, multimeters, and more).
  11
  12 libsigrok is a shared library written in C which provides the basic API
  13 for talking to hardware and reading/writing the acquired data into various
  14 input/output file formats.
  15
  16
  17 Status
  18 ------
  19
  20 libsigrok is in a usable state and has had official tarball releases.
  21
  22 While the API can change from release to release, this will always be
  23 properly documented and reflected in the package version number and
  24 in the shared library / libtool / .so-file version numbers.
  25
  26 However, there are _NO_ guarantees at all for stable APIs in git snapshots!
  27 Distro packagers should only use released tarballs (no git snapshots).
  28
  29
  30 Requirements
  31 ------------
  32
  33  - git
  34  - gcc (>= 4.0)
  35  - make
  36  - autoconf >= 2.63
  37  - automake >= 1.11
  38  - libtool
  39  - pkg-config >= 0.22
  40  - libglib >= 2.32.0
  41  - libzip >= 0.8
  42  - libusb-1.0 >= 1.0.9 (optional, used by most drivers)
  43  - libftdi >= 0.16 (optional, used by some drivers)
  44  - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
  45  - check >= 0.9.4 (optional, only needed to run unit tests)
  46
  47
  48 Building and installing
  49 -----------------------
  50 Get the libsigrok4DSLogic source code from: www.dreamsourcelab.com/download.html
  51 In order to build it, run:
  52
  53  $ cd libsigrok
  54  $ ./autogen.sh
  55  $ ./configure
  56  $ make
  57
  58 For installing libsigrok4DSLogic:
  59
  60  $ make install
  61
  62 See INSTALL or the following wiki page for more (OS-specific) instructions:
  63
  64  http://sigrok.org/wiki/Building
  65
  66
  67 Copyright and license
  68 ---------------------
  69
  70 libsigrok4DSLogic is licensed under the terms of the GNU General Public License
  71 (GPL), version 3 or later.
  72
  73 While some individual source code files are licensed under the GPLv2+, and
  74 some files are licensed under the GPLv3+, this doesn't change the fact that
  75 the library as a whole is licensed under the terms of the GPLv3+.
  76
  77 Please see the individual source files for the full list of copyright holders.
  78
  79
  80 Mailing lists
  81 -------------
  82
  83 There are two mailing lists for sigrok/libsigrok:
  84
  85  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  86  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  87
  88
  89 IRC
  90 ---
  91
  92 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  93
  94
  95 Website
  96 -------
  97
  98  http://sigrok.org/wiki/Libsigrok
  99  http://dreamsourcelab.com
 100