Houston, we have a trunk.
[debian/gnuradio] / pmt / README
1 #
2 # Copyright 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., 59 Temple Place - Suite 330,
19 # Boston, MA 02111-1307, USA.
20
21
22 This directory hierarchy contains an implementation of 
23 polymorphic types.  These are similar to lisp or python data objects,
24 and implement transparent reference counting using the boost shared_ptr
25 templates.
26
27 To build the examples from the tarball use the normal recipe:
28
29   $ ./configure
30   $ make
31   $ make check
32
33 If you're building from CVS, you'll need to use this sequence, since
34 CVS doesn't contain configure or the generated Makefiles.
35
36   $ ./bootstrap
37   $ ./configure
38   $ make
39   $ make check
40
41
42 The doc directory is not built by default.  This is to avoid spurious
43 build problems on systems that don't have xmlto installed.  If you
44 have xmlto and its dependencies installed, you can build the html
45 version of the howto article by cd'ing to doc and invoking make.