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 sigrok-firmware is a collection of firmware files required for some of the
  10 devices libsigrok supports (logic analyzers, oscilloscopes, or others).
  11
  12 We only carry firmware files for which we have an explicit permission/license
  13 that allows at _least_ redistribution of the firmware.
  14
  15
  16 Status
  17 ------
  18
  19 sigrok-firmware is in a usable state and has had official tarball releases.
  20
  21
  22 Building and installing
  23 -----------------------
  24
  25 In order to get the sigrok-firmware source code and build it, run:
  26
  27  $ git clone git://sigrok.org/sigrok-firmware
  28  $ cd sigrok-firmware
  29  $ ./autogen.sh
  30  $ ./configure
  31  $ make
  32
  33 For installing sigrok-firmware:
  34
  35   $ make install
  36
  37 This will install the files into /usr/local/share/sigrok-firmware per default.
  38
  39 You can override the install directory like this:
  40
  41   $ ./configure --prefix=/usr
  42
  43 See INSTALL or the following wiki page for more (OS-specific) instructions:
  44
  45  http://sigrok.org/wiki/Building
  46
  47
  48 Copyright and license
  49 ---------------------
  50
  51 The 'sigrok-firmware' project/repo/tarball has no license per se, since
  52 it's just a collection of firmware files from various sources.
  53
  54 Copyright and license info for these firmware files is available here:
  55
  56  * asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.
  57
  58
  59 Mailing lists
  60 -------------
  61
  62 There are two mailing lists for sigrok/sigrok-firmware:
  63
  64  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  65  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  66
  67
  68 IRC
  69 ---
  70
  71 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  72
  73
  74 Website
  75 -------
  76
  77  http://sigrok.org/wiki/Firmware
  78