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  $ make
  30
  31 For installing sigrok-firmware:
  32
  33   $ make install
  34
  35 This will install the files into /usr/local/share/sigrok-firmware per default.
  36
  37 You can override the install directory like this:
  38
  39   $ make DESTDIR=/tmp/foo install
  40
  41 Please see the following wiki pages for more detailed instructions:
  42
  43  http://sigrok.org/wiki/Linux
  44  http://sigrok.org/wiki/Mac_OS_X
  45  http://sigrok.org/wiki/Windows
  46  http://sigrok.org/wiki/FreeBSD
  47
  48
  49 Licenses
  50 --------
  51
  52  * asix-sigma/*.fw: See asix-sigma/LICENSE.Sigma.
  53
  54
  55 Mailing lists
  56 -------------
  57
  58 There are two mailing lists for sigrok/sigrok-firmware:
  59
  60  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  61  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  62
  63
  64 IRC
  65 ---
  66
  67 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  68
  69
  70 Website
  71 -------
  72
  73  http://sigrok.org/wiki/Firmware
  74