Merge branch 'dfsg-orig'

[debian/gnuradio] / gr-howto-write-a-block / README

diff --git a/gr-howto-write-a-block/README b/gr-howto-write-a-block/README
new file mode 100644 (file)
index 0000000..368e719
--- /dev/null
+++ b/gr-howto-write-a-block/README
@@ -0,0 +1,45 @@
+#
+# Copyright 2005,2006,2009 Free Software Foundation, Inc.
+# 
+# This file is part of GNU Radio
+# 
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+# 
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with GNU Radio; see the file COPYING.  If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+# 
+
+This directory (and the resulting tarball) contains a build tree with
+examples, Makefiles, etc that demonstrate how to write signal
+processing blocks for the GNU Radio system.  This directory is
+intentionally distributed separately from the unified tarball of the
+rest of GNU Radio in order to avoid problems for people who have begun
+to write blocks with a modified copy of gr-howto-write-a-block.
+
+This package requires that gnuradio-core is already installed.  It
+also depends on some GNU Radio prerequisites, such as Boost and
+cppunit.
+
+To build the examples from the tarball use the normal recipe:
+
+  $ ./configure
+  $ make
+  $ make check
+
+If you're building from git, you'll need to use this sequence, since
+git doesn't contain configure or the generated Makefiles.
+
+  $ ./bootstrap
+  $ ./configure
+  $ make
+  $ make check