Note that gnuradio-core and boost are required.
[debian/gnuradio] / 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 2, 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 tarball contains a build tree with examples, Makefiles, etc that
23 demonstrate how to write signal processing blocks for the GNU Radio
24 system.  
25
26 This package requires that gnuradio-core is already installed.  It
27 also depends on some GNU Radio prerequisites, such as boost.
28
29 To build the examples from the tarball use the normal recipe:
30
31   $ ./configure
32   $ make
33   $ make check
34
35 If you're building from CVS, you'll need to use this sequence, since
36 CVS doesn't contain configure or the generated Makefiles.
37
38   $ ./bootstrap
39   $ ./configure
40   $ make
41   $ make check
42
43
44 The doc directory is not built by default.  This is to avoid spurious
45 build problems on systems that don't have xmlto installed.  If you
46 have xmlto and its dependencies installed, you can build the html
47 version of the howto article by cd'ing to doc and invoking make.