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 fx2lafw is a Free/Libre/Open-source firmware for logic analyzers based on
  10 the Cypress EZ-USB FX2(LP) chip.
  11
  12 It is licensed under the terms of the GNU GPL (version 2 or later), and uses
  13 additional helper code (fx2lib), licensed under the GNU LGPL (version 2.1
  14 or later).
  15
  16
  17 Status
  18 ------
  19
  20 sigrok-firmware-fx2lafw is in a usable state and has had official
  21 tarball releases.
  22
  23
  24 Requirements
  25 ------------
  26
  27  - In order to build fx2lafw you need the 'sdcc' compiler.
  28    On Debian you can install it via:
  29
  30      $ apt-get install sdcc
  31
  32  - You need libsigrok >= 0.1.1 in order to make use of fx2lafw. Earlier
  33    versions didn't have support for FX2 devices using this firmware.
  34
  35
  36 Building and installing
  37 -----------------------
  38
  39 In order to get the sigrok-firmware-fx2lafw source code and build it, run:
  40
  41  $ git clone git://sigrok.org/sigrok-firmware-fx2lafw
  42  $ cd sigrok-firmware-fx2lafw
  43  $ make
  44
  45 For installing sigrok-firmware-fx2lafw:
  46
  47  $ make install
  48
  49 The generated *.fw files are installed into /usr/local/share/sigrok-firmware.
  50
  51 You can override the install location like this:
  52
  53  $ make install DESTDIR=/usr/share/sigrok-firmware
  54
  55 Please see the following wiki pages for more detailed instructions:
  56
  57  http://sigrok.org/wiki/Linux
  58  http://sigrok.org/wiki/Mac_OS_X
  59  http://sigrok.org/wiki/Windows
  60  http://sigrok.org/wiki/FreeBSD
  61
  62
  63 fx2lib
  64 ------
  65
  66 The fx2lafw code uses a (slightly modified) "fx2lib" helper library.
  67
  68 It was imported into fx2lafw from
  69
  70   git://github.com/ubixum/fx2lib.git
  71
  72 as of Feb 12, 2012 (git hash "416c104cbd").
  73
  74 The following files/directories were removed, as they're not needed
  75 for our purposes: CHANGELOG, COPYING*, docs/, examples/, fw/, and utils/.
  76
  77
  78 Mailing lists
  79 -------------
  80
  81 There are two mailing lists for sigrok/sigrok-firmware-fx2lafw:
  82
  83  https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  84  https://lists.sourceforge.net/lists/listinfo/sigrok-commits
  85
  86
  87 IRC
  88 ---
  89
  90 You can find the sigrok developers in the #sigrok IRC channel on Freenode.
  91
  92
  93 Website
  94 -------
  95
  96  http://sigrok.org/wiki/Fx2lafw
  97