git.gag.com Git - debian/gnuradio/blob - gr-howto-write-a-block/README

   1 #
   2 # Copyright 2005, 2006 Free Software Foundation, Inc.
   3 #
   4 # This file is part of GNU Radio
   5 #
   6 # GNU Radio is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3, or (at your option)
   9 # any later version.
  10 #
  11 # GNU Radio is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with GNU Radio; see the file COPYING.  If not, write to
  18 # the Free Software Foundation, Inc., 51 Franklin Street,
  19 # Boston, MA 02110-1301, USA.
  20 #
  21
  22 This directory (and the resulting tarball) contains a build tree with
  23 examples, Makefiles, etc that demonstrate how to write signal
  24 processing blocks for the GNU Radio system.  This directory is
  25 intentionally distributed separately from the unified tarball of the
  26 rest of GNU Radio in order to avoid problems for people who have begun
  27 to write blocks with a modified copy of gr-howto-write-a-block.
  28
  29 This package requires that gnuradio-core is already installed.  It
  30 also depends on some GNU Radio prerequisites, such as boost.
  31
  32 To build the examples from the tarball use the normal recipe:
  33
  34   $ ./configure
  35   $ make
  36   $ make check
  37
  38 If you're building from CVS, you'll need to use this sequence, since
  39 CVS doesn't contain configure or the generated Makefiles.
  40
  41   $ ./bootstrap
  42   $ ./configure
  43   $ make
  44   $ make check
  45
  46
  47 The doc directory is not built by default.  This is to avoid spurious
  48 build problems on systems that don't have xmlto installed.  If you
  49 have xmlto and its dependencies installed, you can build the html
  50 version of the howto article by cd'ing to doc and invoking make.