when gr_firdes.i was last touched, my version 2 filter design programs were removed...

[debian/gnuradio] / README

diff --git a/README b/README
index 90052eed5594825f7b2f29b956265b1a3fbf78c3..6229ecd204e2cf2633af5afa7fcc579670105635 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,11 @@
 #
 #

-# Copyright 2001,2002,2003,2004,2005,2006 Free Software Foundation, Inc.
+# Copyright 2001,2002,2003,2004,2005,2006,2007 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
 # 
 # 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 2, or (at your option)
+# 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,
 # any later version.
 # 
 # GNU Radio is distributed in the hope that it will be useful,


@@ -25,8 +25,14 @@ Welcome to GNU Radio!
 As of August 3, 2006 we have restructured the GNU Radio build process
 and moved the source code repository from CVS to subversion.
 
 As of August 3, 2006 we have restructured the GNU Radio build process
 and moved the source code repository from CVS to subversion.
 

+

 Please see http://gnuradio.org/trac for the wiki, bug tracking,
 Please see http://gnuradio.org/trac for the wiki, bug tracking,

-and source code viewer.
+and source code viewer.  If you've got questions about GNU Radio, please
+subscribe to the discuss-gnuradio mailing list and post your questions
+there.  http://gnuradio.org/trac/wiki/MailingLists
+There is also a "Build Guide" in the wiki that contains OS specific
+recommendations.  See http://gnuradio.org/trac/wiki/BuildGuide
+

 
 The bleeding edge code can be found in our subversion repository at
 http://gnuradio.org/svn.  To checkout the latest, use this
 
 The bleeding edge code can be found in our subversion repository at
 http://gnuradio.org/svn.  To checkout the latest, use this


@@ -114,6 +120,19 @@ install both packages.  (Most GNU/Linux systems are like this, but
 pkgsrc is not and instead uses -devel to indicate a package of a
 not-yet-released or unstable version.)
 
 pkgsrc is not and instead uses -devel to indicate a package of a
 not-yet-released or unstable version.)
 

+For those using pkgsrc, see gnuradio-pkg_chk.conf.  Those not using
+pkgsrc may also find the list useful.
+
+(0) GNU make
+
+It used to be required to have a "reasonable make", meaning GNU make,
+BSD make, or perhaps Solaris make.  It is now required to use GNU
+make.  Version 3.81 should certainly work; the intent is not to
+require the bleeding edge.
+
+Note that the examples below are written with "make".  They probably
+should say "gmake", as GNU make is installed as gmake when it is not
+the native make.

 
 (1) The "autotools"
 
 
 (1) The "autotools"
 


@@ -148,7 +167,9 @@ floating point version which we use.  You should also use either the
 respectively.
 
 [FIXME: GNU/Linux packages of single-precision fftw are typically called ??]
 respectively.
 
 [FIXME: GNU/Linux packages of single-precision fftw are typically called ??]

-In systems using pkgsrc, install math/fftwf.
+
+In systems using pkgsrc, install math/fftwf, which provides the
+single-precision libraries.

 
 
 (4) Python 2.3 or later              http://www.python.org
 
 
 (4) Python 2.3 or later              http://www.python.org


@@ -158,18 +179,18 @@ python into a bunch of separate packages including python-devel or
 libpython you'll most likely need those too.
 
 
 libpython you'll most likely need those too.
 
 

-(5) Numeric python library   http://numeric.scipy.org
+(5) Numpy python library   http://numeric.scipy.org

 
 Provides a high performance array type for Python.
 
 Provides a high performance array type for Python.

-http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=1351
+http://numpy.scipy.org
+http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103

 
 
 
 

-(6) The Boost C++ Libraries    http://www.boost.org
+(6) The Boost C++ Libraries (1.35 or later)  http://www.boost.org

 
 

-We use the Smart Pointer library.  Most systems already have the boost
-libraries available.  In the unlikely event that yours doesn't,
-download the source and follow the build instructions.  They're
-different from the normal ./configure && make
+We use Smart Pointers, the thread library and a bunch of other boost stuff.
+If your system doesn't have boost 1.35 or later, see README.building-boost
+for additional info.

 
 
 (7) cppunit 1.9.14 or later.   http://cppunit.sourceforge.net
 
 
 (7) cppunit 1.9.14 or later.   http://cppunit.sourceforge.net


@@ -179,8 +200,7 @@ Unit testing framework for C++.
 
 (8) Simple Wrapper Interface Generator.  http://www.swig.org
 
 
 (8) Simple Wrapper Interface Generator.  http://www.swig.org
 

-These versions are known to work:
-  1.3.23, 1.3.24, 1.3.25, 1.3.27, 1.3.28, 1.3.29
+As of repository version 4045, gnuradio requires version 1.3.31 or newer.

 
 
 (9) SDCC: Small Device C Compiler.  http://sdcc.sourceforge.net/
 
 
 (9) SDCC: Small Device C Compiler.  http://sdcc.sourceforge.net/


@@ -191,16 +211,25 @@ This includes a C compiler and linker for the 8051.  It's required to
 build the firmware for the USRP.  If you don't have a USRP, don't
 worry about it.
 
 build the firmware for the USRP.  If you don't have a USRP, don't
 worry about it.
 

+(10) Guile 1.6 or 1.8 
+
+Scheme interpreter.  http://www.gnu.org/software/guile/guile.html
+
+

 
 Optional, but nice to have:
 
 
 Optional, but nice to have:
 

-(10) wxPython.  Python binding for the wxWidgets GUI framework.  Use
+(11) wxPython.  Python binding for the wxWidgets GUI framework.  Use

 version 2.5.2.7 or later.  Again, almost all systems have this
 available.
 
 As a last resort, build it from source (not recommended!)
 http://www.wxpython.org
 
 version 2.5.2.7 or later.  Again, almost all systems have this
 available.
 
 As a last resort, build it from source (not recommended!)
 http://www.wxpython.org
 

+(12) xmlto version ? or later.   http://cyberelk.net/tim/xmlto/index.html
+
+Wrapper for XML conversion tools to ease e.g. making html from docbook.
+

 
 ----------------------------------------------------------------
 
 
 ----------------------------------------------------------------
 


@@ -219,14 +248,6 @@ installed version of python.
 You may want to add this to your shell init file (~/.bash_profile if
 you use bash).
 
 You may want to add this to your shell init file (~/.bash_profile if
 you use bash).
 

-Note that on Fedora Core 4 and 5 when running on X86_64 machines,
-python is shippped with a strange (wrong) configuration that requires
-you to add both the lib64 and lib paths to your PYTHONPATH.
-E.g.,
-
-  $ export PYTHONPATH=/usr/local/lib64/python2.4/site-packages:/usr/local/lib/python2.4/site-packages
-
-[Don't complain to us, complain to the Fedora Core packagers.]

 
 
 Another handy trick if for example your fftw includes and libs are
 
 
 Another handy trick if for example your fftw includes and libs are