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