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 Requirements for the C library:
  31
  32  - git (only needed when building from git)
  33  - gcc (>= 4.0) or clang
  34  - make
  35  - autoconf >= 2.63 (only needed when building from git)
  36  - automake >= 1.11 (only needed when building from git)
  37  - libtool (only needed when building from git)
  38  - pkg-config >= 0.22
  39  - libglib >= 2.34.0
  40  - libzip >= 0.10
  41  - libserialport >= 0.1.0 (optional, used by some drivers)
  42  - librevisa >= 0.0.20130812 (optional, used by some drivers)
  43  - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
  44  - libftdi >= 0.16 or libftdi1 >= 1.0 (optional, used by some drivers)
  45  - libgpib (optional, used by some drivers)
  46  - check >= 0.9.4 (optional, only needed to run unit tests)
  47  - doxygen (optional, only needed for the C API docs)
  48  - graphviz (optional, only needed for the C API docs)
  49
  50 Requirements for the C++ bindings:
  51
  52  - libsigrok >= 0.3.0 (the libsigrok C library, see above)
  53  - A C++ compiler with C++11 support (-std=c++11 option), e.g.
  54    - g++ (>= 4.7)
  55    - clang++ (>= 3.1)
  56  - autoconf-archive (only needed when building from git)
  57  - doxygen (required for building the bindings, not only for C++ API docs!)
  58  - graphviz (optional, only needed for the C++ API docs)
  59  - Python (2 or 3) executable (development files are not needed)
  60  - glibmm-2.4 (>= 2.32.0)
  61
  62 Requirements for the Python bindings:
  63
  64  - libsigrokxx >= 0.3.0 (the libsigrok C++ bindings, see above)
  65  - Python >= 2.7 or Python >= 3 (including development files!)
  66  - Python setuptools (for Python 2 or 3)
  67  - pygobject >= 3.0.0 (for Python 2 or 3), a.k.a python-gi
  68  - numpy (for Python 2 or 3)
  69  - SWIG >= 2.0.0
  70  - doxygen (optional, only needed for the Python API docs)
  71  - graphviz (optional, only needed for the Python API docs)
  72  - doxypy (optional, only needed for the Python API docs)
  73
  74 Requirements for the Java bindings:
  75
  76  - libsigrokxx >= 0.3.0 (the libsigrok C++ bindings, see above)
  77  - SWIG >= 2.0.0
  78  - Java JDK (for JNI includes and the javac/jar binaries)
  79  - doxygen (optional, only needed for the Java API docs)
  80  - graphviz (optional, only needed for the Java API docs)
  81
  82
  83 Building and installing
  84 -----------------------
  85
  86 In order to get the libsigrok source code and build it, run:
  87
  88  $ git clone git://sigrok.org/libsigrok
  89  $ cd libsigrok
  90  $ ./autogen.sh
  91  $ ./configure
  92  $ make
  93
  94 For installing libsigrok:
  95
  96  $ make install
  97
  98 See INSTALL or the following wiki page for more (OS-specific) instructions:
  99
 100  http://sigrok.org/wiki/Building
 101
 102
 103 Device-specific issues
 104 ----------------------
 105
 106 Please check README.devices for some notes and hints about device- or
 107 driver-specific issues to be aware of.
 108
 109
 110 Firmware
 111 --------
 112
 113 Some devices supported by libsigrok need a firmware to be uploaded before the
 114 device can be used. See README.devices for details.
 115
 116
 117 Copyright and license
 118 ---------------------
 119
 120 libsigrok is licensed under the terms of the GNU General Public License
 121 (GPL), version 3 or later.
 122
 123 While some individual source code files are licensed under the GPLv2+, and
 124 some files are licensed under the GPLv3+, this doesn't change the fact that
 125 the library as a whole is licensed under the terms of the GPLv3+.
 126
 127 Please see the individual source files for the full list of copyright holders.
 128
 129
 130 Mailing list
 131 ------------
 132
 133  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
 134
 135
 136 IRC
 137 ---
 138
 139 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
 140
 141
 142 Website
 143 -------
 144
 145  http://sigrok.org/wiki/Libsigrok
 146