From 5d69a524f81f234b3fbc41d49ba18d6f6886baba Mon Sep 17 00:00:00 2001 From: jcorgan Date: Thu, 3 Aug 2006 04:51:51 +0000 Subject: Houston, we have a trunk. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@3122 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 190 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 000000000..dfc0ac8d5 --- /dev/null +++ b/README @@ -0,0 +1,190 @@ +# +# Copyright 2001,2002,2003,2004,2005 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 2, 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., 59 Temple Place - Suite 330, +# Boston, MA 02111-1307, USA. +# + +------------------------------------------------------------------------------- + + IMPORTANT + +------------------------------------------------------------------------------- + +GNU Radio is now broken up into several packages. You're looking at +the gnuradio-core. You'll probably want some or all of these too. +Build and install them in the order listed here: + + gnuradio-core # main library + gnuradio-examples # examples + gr-audio-alsa # support for sounds cards using ALSA (prefered under GNU/Linux) + gr-audio-oss # support for sounds cards using OSS + gr-audio-jack # support for JACK Audio Connection Kit + gr-audio-windows # support for sounds cards using Windows Wave + gr-comedi # support for DAQ cards using COMEDI + gr-wxgui # GUI framework built on wxPython + usrp # non-GNU Radio specific portion of usrp + gr-usrp # glues usrp into GNU Radio + mc4020 # GNU/Linux driver for Measurement Computing PCI-DAS4020/12 A/D board + gr-mc4020 # the glue that ties the mc4020 driver into GNU Radio + + +------------------------------------------------------------------------------- + + KNOWN INCOMPATIBILITIES + + + GNU Radio triggers bugs in g++ 3.3 for X86. DO NOT USE GCC 3.3. + gcc 3.2 and 3.4 are known to work well. + +------------------------------------------------------------------------------- + +Prerequisites (you may already have these): + +(1) pkgconfig 0.15.0 or later http://www.freedesktop.org/Software/pkgconfig + +From the web site: + +pkgconfig is a system for managing library compile/link flags that +works with automake and autoconf. It replaces the ubiquitous *-config +scripts you may have seen with a single tool. + + +(2) FFTW 3.0 or later http://www.fftw.org + +IMPORTANT!!! When building FFTW, you MUST use the --enable-single and +--enable-shared configure options. This builds the single precision +floating point version which we use. You should also use either the +--enable-3dnow or --enable-sse options if you're on an Athlon or Pentium +respectively. + + +(3) Python 2.3 or later http://www.python.org + +Python 2.3 or later is now required. If your distribution splits +python into a bunch of separate RPMS including python-devel or +libpython you'll most likely need those too. + + +(4) Numeric python library http://numeric.scipy.org + +Provides a high performance array type for Python. + + +(5) The Boost C++ Libraries http://www.boost.org + +We use the Smart Pointer library. Fedore Core 2 has a package for +this, boost-devel-1.31.0-7. Otherwise download the source and follow +the build instructions. They're a bit different from the normal +./configure && make + + +(6) cppunit 1.9.14 or later. http://cppunit.sourceforge.net + +Unit testing framework for C++. + + +(7) 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 + +---------------------------------------------------------------- + +For the impatient, just do the following: + + $ ./configure + $ make + $ make check + $ make install + +If it doesn't work, fix it and send us a patch... + + +See http://www.gnu.org/software/gnuradio/ for an overview. +The project is hosted at http://savannah.gnu.org/projects/gnuradio/ + + +If you've got doxygen installed and provide the --enable-doxygen +configure option, the build process creates documentation for the +class hierarchy etc. Point your browser at +gnuradio-core/doc/html/index.html + + +To run the examples you'll need to set PYTHONPATH. +Note that the python version number in the path needs to match your +installed version of python. + + $ export PYTHONPATH=/usr/local/lib/python2.3/site-packages + +You may want to add this to your ~/.bash_profile + + + +---------------------------------------------------------------- + + Notes on building GNU Radio from the CVS repository + +---------------------------------------------------------------- + +If you're building from the CVS repository YOU MUST BE PLAYING BY THE +RULES THAT THE OTHER DEVELOPERS ARE USING. This is especially true +with regard to the versions of the tools below... + +Ensure that you've got THESE VERSIONS of the following tools: + + autoconf 2.57 or later + automake 1.7.4 or later + libtool 1.5 or later + swig 1.3.{23,24,25,27,28,29} + +If you're using earlier versions than these, don't expect the system +to build. Get these versions or something later. They're available +at any of the GNU mirrors. + +Then, check out a copy of GNU Radio. + +See http://www.gnu.org/software/gnuradio for directions on anonymous +access to the CVS repository. + +Then in the top level directory, execute + + $ ./bootstrap + +This builds configure from configure.ac and also builds all the +Makefile.in's from the Makefile.am's. + +Then carry on as usual: + + $ ./configure + $ make + $ make check + $ make install + + +For the easiest way to build from CVS, see +http://comsec.com/wiki?HowtoBuildFromCVS + + + +Another handy trick if for example your fftw includes and libs are +installed in, say ~/local/include and ~/local/lib, instead of +/usr/local is this: + + $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/local/lib + $ make CPPFLAGS="-I$HOME/local/include" + -- cgit From 559f82a0d10f604b0b27cfb8663d93b1625dbd8b Mon Sep 17 00:00:00 2001 From: eb Date: Fri, 4 Aug 2006 01:54:23 +0000 Subject: Cleaned up top-level README, and fixed or deleted lower level ones as appropriate. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@3133 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 197 +++++++++++++++++++++++++++++++++++------------------------------ 1 file changed, 106 insertions(+), 91 deletions(-) (limited to 'README') diff --git a/README b/README index dfc0ac8d5..d5a0b6e6a 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ # -# Copyright 2001,2002,2003,2004,2005 Free Software Foundation, Inc. +# Copyright 2001,2002,2003,2004,2005,2006 Free Software Foundation, Inc. # # This file is part of GNU Radio # @@ -19,28 +19,57 @@ # Boston, MA 02111-1307, USA. # -------------------------------------------------------------------------------- +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. + +Please see http://gnuradio.utah.edu/trac for the wiki, bug tracking, +and source code viewer. + +The bleeding edge code can be found in our subversion repository at +http://gnuradio.utah.edu/svn. To checkout the latest, use this +command: + + $ svn co http://gnuradio.utah.edu/svn/gnuradio/trunk co gnuradio + +For information about subversion, please see: + http://subversion.tigris.org/ - IMPORTANT -------------------------------------------------------------------------------- -GNU Radio is now broken up into several packages. You're looking at -the gnuradio-core. You'll probably want some or all of these too. -Build and install them in the order listed here: +GNU Radio is now distributed as one giant blob, instead of N smaller +blobs. We believe that this will reduce some of the build problems +people were seeing. Now you'll always get all of the code, and the +configure step will determine which components can be built on your +system. - gnuradio-core # main library - gnuradio-examples # examples - gr-audio-alsa # support for sounds cards using ALSA (prefered under GNU/Linux) - gr-audio-oss # support for sounds cards using OSS - gr-audio-jack # support for JACK Audio Connection Kit - gr-audio-windows # support for sounds cards using Windows Wave - gr-comedi # support for DAQ cards using COMEDI - gr-wxgui # GUI framework built on wxPython - usrp # non-GNU Radio specific portion of usrp - gr-usrp # glues usrp into GNU Radio - mc4020 # GNU/Linux driver for Measurement Computing PCI-DAS4020/12 A/D board - gr-mc4020 # the glue that ties the mc4020 driver into GNU Radio + +How to Build GNU Radio: + + (1) Ensure that you've satisfied the external dependencies listed + below. With the exception of SDCC, the following GNU/Linux + distributions are known to come with all required dependencies + pre-packaged: Ubuntu 6.06, SuSE 10.0 (the pay version, not the + free download), Fedora Core 5. Other distribution may work too. + We know these three are easy. The required packages may be + contained on your installation CD/DVD, or may be loaded over the + net. The specifics vary depending on your GNU/Linux + distribution. See the wiki at + http://gnuradio.utah.edu/trac/wiki for details. + + FIXME: update the wiki; talk about OS/X, NetBSD and MinGW too. + + (2) do the "usual dance" + + $ ./bootstrap # not reqd when building from the tarball + $ ./configure + $ make && make check + $ sudo make install + + +That's it! ------------------------------------------------------------------------------- @@ -48,14 +77,41 @@ Build and install them in the order listed here: KNOWN INCOMPATIBILITIES - GNU Radio triggers bugs in g++ 3.3 for X86. DO NOT USE GCC 3.3. - gcc 3.2 and 3.4 are known to work well. + GNU Radio triggers bugs in g++ 3.3 for X86. DO NOT USE GCC 3.3 on + the X86 platform. g++ 3.2, 3.4, and the 4.* series are known to work well. ------------------------------------------------------------------------------- -Prerequisites (you may already have these): +------------------------------------------------------------------------------- + + External dependencies + +------------------------------------------------------------------------------- + +Prerequisites: Before trying to build these from source, please try +your installation tool (apt-get, YaST, yum, urpmi, etc.) first. +Contemporary distributions have these packages available. + +You'll need to do a bit of sleuthing to figure out what your OS and +packaging system calls these. If your system has both a foo and a +foo-devel package, install them both. + + +(1) The "autotools" + + autoconf 2.57 or later + automake 1.7.4 or later + libtool 1.5 or later + +If your system has automake-1.4, there's a good chance it also has +automake-1.7 or later. Check your install disk and/or try: + + $ man update-alternatives + +for info on how some distributions support multiple versions. + -(1) pkgconfig 0.15.0 or later http://www.freedesktop.org/Software/pkgconfig +(2) pkgconfig 0.15.0 or later http://www.freedesktop.org/Software/pkgconfig From the web site: @@ -64,7 +120,7 @@ works with automake and autoconf. It replaces the ubiquitous *-config scripts you may have seen with a single tool. -(2) FFTW 3.0 or later http://www.fftw.org +(3) FFTW 3.0 or later http://www.fftw.org IMPORTANT!!! When building FFTW, you MUST use the --enable-single and --enable-shared configure options. This builds the single precision @@ -73,56 +129,63 @@ floating point version which we use. You should also use either the respectively. -(3) Python 2.3 or later http://www.python.org +(4) Python 2.3 or later http://www.python.org Python 2.3 or later is now required. If your distribution splits python into a bunch of separate RPMS including python-devel or libpython you'll most likely need those too. -(4) Numeric python library http://numeric.scipy.org +(5) Numeric python library http://numeric.scipy.org Provides a high performance array type for Python. +http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=1351 -(5) The Boost C++ Libraries http://www.boost.org +(6) The Boost C++ Libraries http://www.boost.org -We use the Smart Pointer library. Fedore Core 2 has a package for -this, boost-devel-1.31.0-7. Otherwise download the source and follow -the build instructions. They're a bit different from the normal -./configure && make +We use the Smart Pointer library. Your distribution almost certainly +has the boost libraries available. In the unlikely event that it +doesn't, download the source and follow the build instructions. +They're different from the normal ./configure && make -(6) cppunit 1.9.14 or later. http://cppunit.sourceforge.net +(7) cppunit 1.9.14 or later. http://cppunit.sourceforge.net Unit testing framework for C++. -(7) 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 ----------------------------------------------------------------- -For the impatient, just do the following: +(9) SDCC: Small Device C Compiler. http://sdcc.sourceforge.net/ + +Use version 2.4.0 or later. + +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. + - $ ./configure - $ make - $ make check - $ make install +Optional, but nice to have: -If it doesn't work, fix it and send us a patch... +(10) wxPython. Python binding for the wxWidgets GUI framework. +Use version 2.5.2.7 or later. Again, your distribution almost +certainly has this available. +As a last resort, build it from source (not recommended!) +http://www.wxpython.org -See http://www.gnu.org/software/gnuradio/ for an overview. -The project is hosted at http://savannah.gnu.org/projects/gnuradio/ +---------------------------------------------------------------- If you've got doxygen installed and provide the --enable-doxygen configure option, the build process creates documentation for the class hierarchy etc. Point your browser at -gnuradio-core/doc/html/index.html +gnuradio/gnuradio-core/doc/html/index.html To run the examples you'll need to set PYTHONPATH. @@ -134,57 +197,9 @@ installed version of python. You may want to add this to your ~/.bash_profile - ----------------------------------------------------------------- - - Notes on building GNU Radio from the CVS repository - ----------------------------------------------------------------- - -If you're building from the CVS repository YOU MUST BE PLAYING BY THE -RULES THAT THE OTHER DEVELOPERS ARE USING. This is especially true -with regard to the versions of the tools below... - -Ensure that you've got THESE VERSIONS of the following tools: - - autoconf 2.57 or later - automake 1.7.4 or later - libtool 1.5 or later - swig 1.3.{23,24,25,27,28,29} - -If you're using earlier versions than these, don't expect the system -to build. Get these versions or something later. They're available -at any of the GNU mirrors. - -Then, check out a copy of GNU Radio. - -See http://www.gnu.org/software/gnuradio for directions on anonymous -access to the CVS repository. - -Then in the top level directory, execute - - $ ./bootstrap - -This builds configure from configure.ac and also builds all the -Makefile.in's from the Makefile.am's. - -Then carry on as usual: - - $ ./configure - $ make - $ make check - $ make install - - -For the easiest way to build from CVS, see -http://comsec.com/wiki?HowtoBuildFromCVS - - - Another handy trick if for example your fftw includes and libs are installed in, say ~/local/include and ~/local/lib, instead of /usr/local is this: $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/local/lib $ make CPPFLAGS="-I$HOME/local/include" - -- cgit From a221cbd5bafce3cb80e25bd65ba3ee83744cc0c5 Mon Sep 17 00:00:00 2001 From: jcorgan Date: Fri, 4 Aug 2006 03:05:48 +0000 Subject: Fixed typo. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@3135 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index d5a0b6e6a..e4806ae1c 100644 --- a/README +++ b/README @@ -32,7 +32,7 @@ The bleeding edge code can be found in our subversion repository at http://gnuradio.utah.edu/svn. To checkout the latest, use this command: - $ svn co http://gnuradio.utah.edu/svn/gnuradio/trunk co gnuradio + $ svn co http://gnuradio.utah.edu/svn/gnuradio/trunk gnuradio For information about subversion, please see: http://subversion.tigris.org/ -- cgit From 86f5c92427b3f4bb30536d76cf63c3fca388fb2f Mon Sep 17 00:00:00 2001 From: eb Date: Wed, 13 Sep 2006 21:30:04 +0000 Subject: Updated FSF address in all files. Fixes ticket:51 git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@3534 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index e4806ae1c..d2378f6bf 100644 --- a/README +++ b/README @@ -15,8 +15,8 @@ # # 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., 59 Temple Place - Suite 330, -# Boston, MA 02111-1307, USA. +# the Free Software Foundation, Inc., 51 Franklin Street, +# Boston, MA 02110-1301, USA. # Welcome to GNU Radio! -- cgit From 6105af538d20a5f945d01044909c90e6a4ae1256 Mon Sep 17 00:00:00 2001 From: eb Date: Sat, 16 Sep 2006 02:14:47 +0000 Subject: Added note about how to work around Fedora Core PYTHONPATH weirdness on X86_64. Closed ticket:39. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@3544 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'README') diff --git a/README b/README index d2378f6bf..9ecf7b0a6 100644 --- a/README +++ b/README @@ -196,6 +196,15 @@ installed version of python. You may want to add this to your ~/.bash_profile +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 installed in, say ~/local/include and ~/local/lib, instead of -- cgit From 2072f53c2b9622bd8cb0d803c24d39a0aee699c2 Mon Sep 17 00:00:00 2001 From: eb Date: Sat, 16 Sep 2006 02:26:42 +0000 Subject: gnuradio.utah.edu --> gnuradio.org git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@3545 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README') diff --git a/README b/README index 9ecf7b0a6..cabaea4a2 100644 --- a/README +++ b/README @@ -25,14 +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. -Please see http://gnuradio.utah.edu/trac for the wiki, bug tracking, +Please see http://gnuradio.org/trac for the wiki, bug tracking, and source code viewer. The bleeding edge code can be found in our subversion repository at -http://gnuradio.utah.edu/svn. To checkout the latest, use this +http://gnuradio.org/svn. To checkout the latest, use this command: - $ svn co http://gnuradio.utah.edu/svn/gnuradio/trunk gnuradio + $ svn co http://gnuradio.org/svn/gnuradio/trunk gnuradio For information about subversion, please see: http://subversion.tigris.org/ @@ -57,7 +57,7 @@ How to Build GNU Radio: contained on your installation CD/DVD, or may be loaded over the net. The specifics vary depending on your GNU/Linux distribution. See the wiki at - http://gnuradio.utah.edu/trac/wiki for details. + http://gnuradio.org/trac/wiki for details. FIXME: update the wiki; talk about OS/X, NetBSD and MinGW too. -- cgit From 15698af5362ece0c9eb14f81ae2e8b483ef8b948 Mon Sep 17 00:00:00 2001 From: gdt Date: Wed, 4 Oct 2006 20:02:48 +0000 Subject: general cleanup: add hints for pkgsrc (dependencies, how to link against them, avoid suggesing to install -devel) adjust language to be more OS-neutral change PYTHONPATH hint example to be 2.4 since that's more likely to be right if blindly copied. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@3711 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 73 +++++++++++++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 52 insertions(+), 21 deletions(-) (limited to 'README') diff --git a/README b/README index cabaea4a2..90052eed5 100644 --- a/README +++ b/README @@ -49,15 +49,28 @@ system. How to Build GNU Radio: (1) Ensure that you've satisfied the external dependencies listed - below. With the exception of SDCC, the following GNU/Linux + below. The word "system" is used to mean "operating system + and/or distribution", and means a full operating system, + including kernel, user-space utilties, and a packaging system + for additional software. On Linux, this means what + "distribution" means. + + With the exception of SDCC, the following GNU/Linux distributions are known to come with all required dependencies pre-packaged: Ubuntu 6.06, SuSE 10.0 (the pay version, not the free download), Fedora Core 5. Other distribution may work too. We know these three are easy. The required packages may be contained on your installation CD/DVD, or may be loaded over the net. The specifics vary depending on your GNU/Linux - distribution. See the wiki at - http://gnuradio.org/trac/wiki for details. + distribution. + + On systems using pkgsrc (e.g. NetBSD and Dragonfly), build + meta-packages/gnuradio, which will build a previous release and + force installation of the dependencies. Then pkg_delete the + gnuradio and usrp packages, which will leave the dependencies. + (This should also work on OSX.) + + See the wiki at http://gnuradio.org/trac/wiki for details. FIXME: update the wiki; talk about OS/X, NetBSD and MinGW too. @@ -89,12 +102,17 @@ That's it! ------------------------------------------------------------------------------- Prerequisites: Before trying to build these from source, please try -your installation tool (apt-get, YaST, yum, urpmi, etc.) first. -Contemporary distributions have these packages available. +your system's installation tool (apt-get, pkg_install, YaST, yum, +urpmi, etc.) first. Most recent systems have these packages +available. You'll need to do a bit of sleuthing to figure out what your OS and -packaging system calls these. If your system has both a foo and a -foo-devel package, install them both. +packaging system calls these. If your system uses the convention of +splitting files needed to run programs compiled with foo and files +needed to do the compilation into packages named foo and foo-devel, +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.) (1) The "autotools" @@ -104,7 +122,8 @@ foo-devel package, install them both. libtool 1.5 or later If your system has automake-1.4, there's a good chance it also has -automake-1.7 or later. Check your install disk and/or try: +automake-1.7 or later. Check your install disk and/or (on GNU/Linux) +try: $ man update-alternatives @@ -128,11 +147,14 @@ floating point version which we use. You should also use either the --enable-3dnow or --enable-sse options if you're on an Athlon or Pentium respectively. +[FIXME: GNU/Linux packages of single-precision fftw are typically called ??] +In systems using pkgsrc, install math/fftwf. + (4) Python 2.3 or later http://www.python.org -Python 2.3 or later is now required. If your distribution splits -python into a bunch of separate RPMS including python-devel or +Python 2.3 or later is now required. If your system splits +python into a bunch of separate packages including python-devel or libpython you'll most likely need those too. @@ -144,10 +166,10 @@ http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=1351 (6) The Boost C++ Libraries http://www.boost.org -We use the Smart Pointer library. Your distribution almost certainly -has the boost libraries available. In the unlikely event that it -doesn't, download the source and follow the build instructions. -They're different from the normal ./configure && make +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 (7) cppunit 1.9.14 or later. http://cppunit.sourceforge.net @@ -172,9 +194,9 @@ worry about it. Optional, but nice to have: -(10) wxPython. Python binding for the wxWidgets GUI framework. -Use version 2.5.2.7 or later. Again, your distribution almost -certainly has this available. +(10) 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 @@ -188,13 +210,14 @@ class hierarchy etc. Point your browser at gnuradio/gnuradio-core/doc/html/index.html -To run the examples you'll need to set PYTHONPATH. -Note that the python version number in the path needs to match your +To run the examples you'll need to set PYTHONPATH. Note that the +prefix and python version number in the path needs to match your installed version of python. - $ export PYTHONPATH=/usr/local/lib/python2.3/site-packages + $ export PYTHONPATH=/usr/local/lib/python2.4/site-packages -You may want to add this to your ~/.bash_profile +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 @@ -212,3 +235,11 @@ installed in, say ~/local/include and ~/local/lib, instead of $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/local/lib $ make CPPFLAGS="-I$HOME/local/include" + + +Sometimes the prerequisites are installed in a location which is not +included in the default compiler and linker search paths. This +happens with pkgsrc and NetBSD. To build, tell configure to use these +locations: + + LDFLAGS="-L/usr/pkg/lib -R/usr/pkg/lib" CPPFLAGS="-I/usr/pkg/include" ./configure --prefix=/usr/gnuradio -- cgit From 1d92f3adb480675cf5a269ea3ead0b5756df1982 Mon Sep 17 00:00:00 2001 From: gdt Date: Sat, 25 Nov 2006 13:10:32 +0000 Subject: Note optional use of xmlto. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@4019 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README') diff --git a/README b/README index 90052eed5..8ec162dde 100644 --- a/README +++ b/README @@ -201,6 +201,10 @@ available. As a last resort, build it from source (not recommended!) http://www.wxpython.org +(11) xmlto version ? or later. http://cyberelk.net/tim/xmlto/index.html + +Wrapper for XML conversion tools to ease e.g. making html from docbook. + ---------------------------------------------------------------- -- cgit From 2963f41e9b8bd7158c68da19331d4e1a3f374c11 Mon Sep 17 00:00:00 2001 From: jcorgan Date: Thu, 30 Nov 2006 23:06:05 +0000 Subject: Require swig version 1.3.31 due to broken 'director' functionality in prior versions. Addresses ticket:106. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@4045 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 8ec162dde..4692f8fcc 100644 --- a/README +++ b/README @@ -179,8 +179,7 @@ Unit testing framework for C++. (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/ -- cgit From 7bf578af31a8986f2ec41fb191958afce0e548f7 Mon Sep 17 00:00:00 2001 From: gdt Date: Wed, 31 Jan 2007 01:28:00 +0000 Subject: spiff up pkg_chk config file: include jack, portaudio and SDL trim boost requirement to boost-headers since GNU Radio only uses smart pointers Add pointer in README, and sugges that the pkg_chk config file may be useful to others as a reference. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@4344 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README') diff --git a/README b/README index 4692f8fcc..c3df73199 100644 --- a/README +++ b/README @@ -114,6 +114,8 @@ 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.) +For those using pkgsrc, see gnuradio-pkg_chk.conf. Those not using +pkgsrc may also find the list useful. (1) The "autotools" -- cgit From b10b4d157f059773d0dd665d040c44453b14501e Mon Sep 17 00:00:00 2001 From: eb Date: Mon, 7 May 2007 20:27:00 +0000 Subject: Added guile dependency to the README git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@5252 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index c3df73199..ebbf31d42 100644 --- a/README +++ b/README @@ -192,17 +192,22 @@ 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. +(10) Guile 1.6 or 1.8 + +Scheme interpreter. http://www.gnu.org/software/guile/guile.html + + 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 -(11) xmlto version ? or later. http://cyberelk.net/tim/xmlto/index.html +(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. -- cgit From bbc84f59726f2aab25a9647c734208adf744e6d3 Mon Sep 17 00:00:00 2001 From: gdt Date: Fri, 11 May 2007 23:53:42 +0000 Subject: Document dependency on GNU make, which previously was official but secret :-) git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@5460 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index ebbf31d42..b5f551522 100644 --- a/README +++ b/README @@ -117,6 +117,17 @@ 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" autoconf 2.57 or later @@ -150,7 +161,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 ??] -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 -- cgit From 9880e7bb383054aa43681b52ebd33c8fd4cb8fcb Mon Sep 17 00:00:00 2001 From: jcorgan Date: Mon, 28 May 2007 17:04:09 +0000 Subject: Merged r5547:5542 from jcorgan/num into trunk. Converts from using Python Numeric to numpy. Trunk passes distcheck. gr-radio-astronomy still needs conversion. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@5553 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index b5f551522..ba882b3f8 100644 --- a/README +++ b/README @@ -173,11 +173,10 @@ python into a bunch of separate packages including python-devel or 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. -http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=1351 - +http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 (6) The Boost C++ Libraries http://www.boost.org -- cgit From 7319f1cc57eb81488e0b13756ed55a9a299cc64e Mon Sep 17 00:00:00 2001 From: eb Date: Wed, 30 May 2007 17:37:45 +0000 Subject: minor doc tweak git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@5571 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 1 + 1 file changed, 1 insertion(+) (limited to 'README') diff --git a/README b/README index ba882b3f8..e338bc38f 100644 --- a/README +++ b/README @@ -176,6 +176,7 @@ libpython you'll most likely need those too. (5) Numpy python library http://numeric.scipy.org Provides a high performance array type for Python. +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 -- cgit From 937b719d2e57d0497293d603da10cac2532346f6 Mon Sep 17 00:00:00 2001 From: eb Date: Sat, 21 Jul 2007 03:44:38 +0000 Subject: Updated license from GPL version 2 or later to GPL version 3 or later. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@6044 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index e338bc38f..2000f73e1 100644 --- a/README +++ b/README @@ -5,7 +5,7 @@ # # 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, -- cgit From e7083c3547577b1faad7d67e68fc8f5c7dc6d12f Mon Sep 17 00:00:00 2001 From: eb Date: Mon, 12 Nov 2007 18:07:31 +0000 Subject: doc cleanup git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@6868 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) (limited to 'README') diff --git a/README b/README index 2000f73e1..a3f1d8b0a 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ # -# 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 # @@ -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. + 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 @@ -242,14 +248,6 @@ installed version of python. 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 -- cgit From 2c8ea58e4d76f54c98d71d3fcc64bc29da490908 Mon Sep 17 00:00:00 2001 From: eb Date: Tue, 19 Aug 2008 23:09:56 +0000 Subject: Merged features/mp-sched -r8915:9335 into the trunk. The trunk now contains the SMP aware scheduler. This changeset introduces a dependency on boost 1.35 or later. See source:gnuradio/trunk/README.building-boost for additional info. git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@9336 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README') diff --git a/README b/README index a3f1d8b0a..6229ecd20 100644 --- a/README +++ b/README @@ -185,12 +185,12 @@ Provides a high performance array type for Python. 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 -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 +(6) The Boost C++ Libraries (1.35 or later) http://www.boost.org + +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 -- cgit From 4c84464a17b1a89a733846bd194ba7cedb1e4429 Mon Sep 17 00:00:00 2001 From: jcorgan Date: Tue, 17 Feb 2009 17:03:56 +0000 Subject: Updated README for gsl and GRC git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@10453 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 36 +++++++++++++++++------------------- 1 file changed, 17 insertions(+), 19 deletions(-) (limited to 'README') diff --git a/README b/README index 6229ecd20..2f7e7229a 100644 --- a/README +++ b/README @@ -22,10 +22,6 @@ 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. - - Please see http://gnuradio.org/trac for the wiki, bug tracking, and source code viewer. If you've got questions about GNU Radio, please subscribe to the discuss-gnuradio mailing list and post your questions @@ -44,14 +40,6 @@ For information about subversion, please see: http://subversion.tigris.org/ - -GNU Radio is now distributed as one giant blob, instead of N smaller -blobs. We believe that this will reduce some of the build problems -people were seeing. Now you'll always get all of the code, and the -configure step will determine which components can be built on your -system. - - How to Build GNU Radio: (1) Ensure that you've satisfied the external dependencies listed @@ -63,8 +51,8 @@ How to Build GNU Radio: With the exception of SDCC, the following GNU/Linux distributions are known to come with all required dependencies - pre-packaged: Ubuntu 6.06, SuSE 10.0 (the pay version, not the - free download), Fedora Core 5. Other distribution may work too. + pre-packaged: Ubuntu 8.10, SuSE 10.0 (the pay version, not the + free download), Fedora Core 9. Other distribution may work too. We know these three are easy. The required packages may be contained on your installation CD/DVD, or may be loaded over the net. The specifics vary depending on your GNU/Linux @@ -78,7 +66,6 @@ How to Build GNU Radio: See the wiki at http://gnuradio.org/trac/wiki for details. - FIXME: update the wiki; talk about OS/X, NetBSD and MinGW too. (2) do the "usual dance" @@ -176,7 +163,8 @@ single-precision libraries. Python 2.3 or later is now required. If your system splits 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. The GNU Radio Companion +application requires Python 2.5 or later. (5) Numpy python library http://numeric.scipy.org @@ -215,21 +203,30 @@ worry about it. Scheme interpreter. http://www.gnu.org/software/guile/guile.html +(11) GNU Scientific Library (gsl) 1.10 or later + +The GNU Radio core library uses some routines from here. Optional, but nice to have: -(11) wxPython. Python binding for the wxWidgets GUI framework. Use +(12) 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 -(12) xmlto version ? or later. http://cyberelk.net/tim/xmlto/index.html +(13) xmlto version ? or later. http://cyberelk.net/tim/xmlto/index.html Wrapper for XML conversion tools to ease e.g. making html from docbook. +(14) Python Cheetah extensions 2.0.0 or later +(15) Python lxml wrappers 2.0.0 or later +(16) Python gtk wrappers 2.10.0 or later + +The GNU Radio Companion application requires these additional Python libraries +to be installed. ---------------------------------------------------------------- @@ -239,7 +236,7 @@ class hierarchy etc. Point your browser at gnuradio/gnuradio-core/doc/html/index.html -To run the examples you'll need to set PYTHONPATH. Note that the +To run the examples you may need to set PYTHONPATH. Note that the prefix and python version number in the path needs to match your installed version of python. @@ -264,3 +261,4 @@ happens with pkgsrc and NetBSD. To build, tell configure to use these locations: LDFLAGS="-L/usr/pkg/lib -R/usr/pkg/lib" CPPFLAGS="-I/usr/pkg/include" ./configure --prefix=/usr/gnuradio + -- cgit From 78c121b8af6995a59335fee39ee7f00600a14658 Mon Sep 17 00:00:00 2001 From: jcorgan Date: Sat, 23 May 2009 22:26:03 +0000 Subject: Doc cleanup git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11106 221aa14e-8319-0410-a670-987f0aec2ac5 --- README | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'README') diff --git a/README b/README index 2f7e7229a..6eeb0fe8a 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ # -# Copyright 2001,2002,2003,2004,2005,2006,2007 Free Software Foundation, Inc. +# Copyright 2001,2002,2003,2004,2005,2006,2007,2009 Free Software Foundation, Inc. # # This file is part of GNU Radio # @@ -159,12 +159,11 @@ 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.5 or later http://www.python.org -Python 2.3 or later is now required. If your system splits +Python 2.5 or later is now required. If your system splits python into a bunch of separate packages including python-devel or -libpython you'll most likely need those too. The GNU Radio Companion -application requires Python 2.5 or later. +libpython you'll most likely need those too. (5) Numpy python library http://numeric.scipy.org @@ -199,10 +198,12 @@ 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. + (10) Guile 1.6 or 1.8 Scheme interpreter. http://www.gnu.org/software/guile/guile.html + (11) GNU Scientific Library (gsl) 1.10 or later The GNU Radio core library uses some routines from here. @@ -211,7 +212,7 @@ The GNU Radio core library uses some routines from here. Optional, but nice to have: (12) wxPython. Python binding for the wxWidgets GUI framework. Use -version 2.5.2.7 or later. Again, almost all systems have this +version 2.8 or later. Again, almost all systems have this available. As a last resort, build it from source (not recommended!) @@ -230,9 +231,8 @@ to be installed. ---------------------------------------------------------------- -If you've got doxygen installed and provide the --enable-doxygen -configure option, the build process creates documentation for the -class hierarchy etc. Point your browser at +If you've got doxygen installed, the build process creates +documentation for the class hierarchy etc. Point your browser at gnuradio/gnuradio-core/doc/html/index.html @@ -240,7 +240,7 @@ To run the examples you may need to set PYTHONPATH. Note that the prefix and python version number in the path needs to match your installed version of python. - $ export PYTHONPATH=/usr/local/lib/python2.4/site-packages + $ export PYTHONPATH=/usr/local/lib/python2.5/site-packages You may want to add this to your shell init file (~/.bash_profile if you use bash). -- cgit From a40feb1dece1b8064f3f81e669f3ed38b60b6dd8 Mon Sep 17 00:00:00 2001 From: Johnathan Corgan Date: Mon, 26 Apr 2010 13:04:23 -0700 Subject: Further updates for removing omnithreads Updates README Removes Darwin specific variable in usrp.pc --- README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README') diff --git a/README b/README index 6eeb0fe8a..4656af2c9 100644 --- a/README +++ b/README @@ -177,7 +177,7 @@ http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 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. +for additional info. (Note: Mac OSX systems require 1.37 or later.) (7) cppunit 1.9.14 or later. http://cppunit.sourceforge.net -- cgit From bd8dd840173e38041b221758ca1baeb4b4584944 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sat, 22 Jan 2011 15:09:54 -0500 Subject: Adding required legal notice of what a copyright year range means that is now used in the configure.ac file (and others in the future). --- README | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README') diff --git a/README b/README index 4656af2c9..069d32024 100644 --- a/README +++ b/README @@ -262,3 +262,16 @@ locations: LDFLAGS="-L/usr/pkg/lib -R/usr/pkg/lib" CPPFLAGS="-I/usr/pkg/include" ./configure --prefix=/usr/gnuradio + +------------------------------------------------------------------------------- + + Legal Matters + +------------------------------------------------------------------------------- + +Some files have been changed many times throughout the +years. Copyright notices at the tops of these files list which years +changes have been made. For some files, changes have occurred in many +consecutive years. These files may often have the format of a year +range (e.g., "2006 - 2011"), which indicates that these files have had +copyrightable changes made during each year in the range, inclusive. -- cgit From e30b824e9165bff69f09121631c3d5a706cbbd39 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Wed, 19 Oct 2011 15:10:58 -0700 Subject: Removing usrp, usrp2, gr-usrp, gr-usrp2. Everything is moving to using UHD. Also removes related M4 and dependency requirements for USRP-related libs. --- README | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) (limited to 'README') diff --git a/README b/README index 069d32024..ec19307dd 100644 --- a/README +++ b/README @@ -61,8 +61,8 @@ How to Build GNU Radio: On systems using pkgsrc (e.g. NetBSD and Dragonfly), build meta-packages/gnuradio, which will build a previous release and force installation of the dependencies. Then pkg_delete the - gnuradio and usrp packages, which will leave the dependencies. - (This should also work on OSX.) + gnuradio package, which will leave the dependencies. (This + should also work on OSX.) See the wiki at http://gnuradio.org/trac/wiki for details. @@ -192,11 +192,7 @@ As of repository version 4045, gnuradio requires version 1.3.31 or newer. (9) SDCC: Small Device C Compiler. http://sdcc.sourceforge.net/ -Use version 2.4.0 or later. - -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. +--> Not required as of v3.5 (10) Guile 1.6 or 1.8 -- cgit From 29299eb3ddadbbbe782127a24e314bbb349422fe Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Fri, 21 Oct 2011 18:06:47 -0400 Subject: docs: updating documentation. More build instructions/information in Doxygen. Added logo to doxygen manual, too. --- README | 44 ++++++++++++++++++++++++++------------------ 1 file changed, 26 insertions(+), 18 deletions(-) (limited to 'README') diff --git a/README b/README index ec19307dd..296b0cec1 100644 --- a/README +++ b/README @@ -22,22 +22,26 @@ Welcome to GNU Radio! -Please see http://gnuradio.org/trac for the wiki, bug tracking, -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 +Please see http://gnuradio.org for the wiki, bug tracking, +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/redmine/projects/gnuradio/wiki/MailingLists + There is also a "Build Guide" in the wiki that contains OS specific -recommendations. See http://gnuradio.org/trac/wiki/BuildGuide +recommendations: +http://gnuradio.org/redmine/projects/gnuradio/wiki/BuildGuide -The bleeding edge code can be found in our subversion repository at -http://gnuradio.org/svn. To checkout the latest, use this -command: +The bleeding edge code can be found in our git repository at +http://gnuradio.org/git/gnuradio.git/. To checkout the latest, use +this command: - $ svn co http://gnuradio.org/svn/gnuradio/trunk gnuradio + $ git clone git://gnuradio.org/gnuradio -For information about subversion, please see: - http://subversion.tigris.org/ +For information about using Git, please see: +http://gnuradio.org/redmine/projects/gnuradio/wiki/DevelopingWithGit How to Build GNU Radio: @@ -64,15 +68,18 @@ How to Build GNU Radio: gnuradio package, which will leave the dependencies. (This should also work on OSX.) - See the wiki at http://gnuradio.org/trac/wiki for details. + See the wiki at http://gnuradio.org for details. + + (2) Building from cmake: - (2) do the "usual dance" + $ mkdir $(builddir) + $ cd $(builddir) + $ cmake [OPTIONS] $(srcdir) + $ make + $ make test + $ sudo make instal - $ ./bootstrap # not reqd when building from the tarball - $ ./configure - $ make && make check - $ sudo make install That's it! @@ -153,7 +160,8 @@ floating point version which we use. You should also use either the --enable-3dnow or --enable-sse options if you're on an Athlon or Pentium respectively. -[FIXME: GNU/Linux packages of single-precision fftw are typically called ??] +GNU/Linux packages of single-precision fftw are typically called +fftw3f. In systems using pkgsrc, install math/fftwf, which provides the single-precision libraries. -- cgit From 1864683c7036b47eee254e75b4a1db60dd3f5d26 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sun, 4 Mar 2012 15:56:56 -0500 Subject: testing something. --- README | 1 + 1 file changed, 1 insertion(+) (limited to 'README') diff --git a/README b/README index 296b0cec1..196c7a489 100644 --- a/README +++ b/README @@ -279,3 +279,4 @@ changes have been made. For some files, changes have occurred in many consecutive years. These files may often have the format of a year range (e.g., "2006 - 2011"), which indicates that these files have had copyrightable changes made during each year in the range, inclusive. + -- cgit From 6d20c58eba20406c3a1d6131e28a5bad8d18a408 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sun, 1 Apr 2012 12:18:54 -0400 Subject: docs: updating README files for working with cmake. --- README | 76 +++++++++++++++++++++++++++++++++--------------------------------- 1 file changed, 38 insertions(+), 38 deletions(-) (limited to 'README') diff --git a/README b/README index 196c7a489..9f56e7f18 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ # -# Copyright 2001,2002,2003,2004,2005,2006,2007,2009 Free Software Foundation, Inc. +# Copyright 2001-2007,2009,2012 Free Software Foundation, Inc. # # This file is part of GNU Radio # @@ -53,14 +53,13 @@ How to Build GNU Radio: for additional software. On Linux, this means what "distribution" means. - With the exception of SDCC, the following GNU/Linux - distributions are known to come with all required dependencies - pre-packaged: Ubuntu 8.10, SuSE 10.0 (the pay version, not the - free download), Fedora Core 9. Other distribution may work too. - We know these three are easy. The required packages may be - contained on your installation CD/DVD, or may be loaded over the - net. The specifics vary depending on your GNU/Linux - distribution. + The following GNU/Linux distributions are known to come with all + required dependencies pre-packaged: Ubuntu >8.10, SuSE 10.0 (the + pay version, not the free download), Fedora Core >9. Other + distribution may work too. We know these three are easy. The + required packages may be contained on your installation CD/DVD, + or may be loaded over the net. The specifics vary depending on + your GNU/Linux distribution. On systems using pkgsrc (e.g. NetBSD and Dragonfly), build meta-packages/gnuradio, which will build a previous release and @@ -78,12 +77,21 @@ How to Build GNU Radio: $ cmake [OPTIONS] $(srcdir) $ make $ make test - $ sudo make instal - + $ sudo make install That's it! +Options: +Useful options include setting the install prefix and the build type: + + -DCMAKE_INSTALL_PREFIX= + -DCMAKE_BUILD_TYPE="" + +Currently, GNU Radio has a "Debug" type that builds with '-g -O2' +useful for debugging the software and a "Release" type that builds +with '-O3', which is the default. + ------------------------------------------------------------------------------- @@ -128,20 +136,7 @@ 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" - - autoconf 2.57 or later - automake 1.7.4 or later - libtool 1.5 or later - -If your system has automake-1.4, there's a good chance it also has -automake-1.7 or later. Check your install disk and/or (on GNU/Linux) -try: - - $ man update-alternatives - -for info on how some distributions support multiple versions. - +(1) cmake 2.6 or later http://www.cmake.org/cmake/resources/software.html (2) pkgconfig 0.15.0 or later http://www.freedesktop.org/Software/pkgconfig @@ -198,44 +193,49 @@ Unit testing framework for C++. As of repository version 4045, gnuradio requires version 1.3.31 or newer. -(9) SDCC: Small Device C Compiler. http://sdcc.sourceforge.net/ - ---> Not required as of v3.5 - - -(10) Guile 1.6 or 1.8 +(9) Guile 1.6 or 1.8 Scheme interpreter. http://www.gnu.org/software/guile/guile.html -(11) GNU Scientific Library (gsl) 1.10 or later +(10) GNU Scientific Library (gsl) 1.10 or later The GNU Radio core library uses some routines from here. Optional, but nice to have: -(12) wxPython. Python binding for the wxWidgets GUI framework. Use +(11) wxPython. Python binding for the wxWidgets GUI framework. Use version 2.8 or later. Again, almost all systems have this available. As a last resort, build it from source (not recommended!) http://www.wxpython.org -(13) xmlto version ? or later. http://cyberelk.net/tim/xmlto/index.html +(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. -(14) Python Cheetah extensions 2.0.0 or later -(15) Python lxml wrappers 2.0.0 or later -(16) Python gtk wrappers 2.10.0 or later +(13) Python Cheetah extensions 2.0.0 or later +(14) Python lxml wrappers 2.0.0 or later +(15) Python gtk wrappers 2.10.0 or later The GNU Radio Companion application requires these additional Python libraries to be installed. +The gr-qtgui requires these packages: + +(16) Qt 4.4 or later +(17) Qwt 5.2 or later +(18) PyQt 4.4 or later +(19) PyQwt 5.2 or later + +It is also useful to have Python's Scipy and Matplot lib packages to +run some of the example. + ---------------------------------------------------------------- -If you've got doxygen installed, the build process creates +If you have doxygen installed, the build process creates documentation for the class hierarchy etc. Point your browser at gnuradio/gnuradio-core/doc/html/index.html -- cgit From 2bf64459036916258dcf3269cec47904fdeba8f6 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sun, 1 Apr 2012 16:13:42 -0400 Subject: Removes all references to guile and scheme, which are no longer needed. The remaining pmt_serial_tags.scm is parsed by Python already. Future modifications could change this format to not confuse the point. --- README | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) (limited to 'README') diff --git a/README b/README index 9f56e7f18..63d093a5e 100644 --- a/README +++ b/README @@ -193,42 +193,37 @@ Unit testing framework for C++. As of repository version 4045, gnuradio requires version 1.3.31 or newer. -(9) Guile 1.6 or 1.8 - -Scheme interpreter. http://www.gnu.org/software/guile/guile.html - - -(10) GNU Scientific Library (gsl) 1.10 or later +(9) GNU Scientific Library (gsl) 1.10 or later The GNU Radio core library uses some routines from here. Optional, but nice to have: -(11) wxPython. Python binding for the wxWidgets GUI framework. Use +(10) wxPython. Python binding for the wxWidgets GUI framework. Use version 2.8 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 +(11) xmlto version ? or later. http://cyberelk.net/tim/xmlto/index.html Wrapper for XML conversion tools to ease e.g. making html from docbook. -(13) Python Cheetah extensions 2.0.0 or later -(14) Python lxml wrappers 2.0.0 or later -(15) Python gtk wrappers 2.10.0 or later +(12) Python Cheetah extensions 2.0.0 or later +(13) Python lxml wrappers 2.0.0 or later +(14) Python gtk wrappers 2.10.0 or later The GNU Radio Companion application requires these additional Python libraries to be installed. The gr-qtgui requires these packages: -(16) Qt 4.4 or later -(17) Qwt 5.2 or later -(18) PyQt 4.4 or later -(19) PyQwt 5.2 or later +(15) Qt 4.4 or later +(16) Qwt 5.2 or later +(17) PyQt 4.4 or later +(18) PyQwt 5.2 or later It is also useful to have Python's Scipy and Matplot lib packages to run some of the example. -- cgit From f919f9dcbb54a08e6e26d6c229ce92fb784fa1b2 Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Fri, 13 Apr 2012 18:36:53 -0400 Subject: Removed whitespace and added dtools/bin/remove-whitespace as a tool to do this in the future. The sed script was provided by Moritz Fischer. --- README | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'README') diff --git a/README b/README index 63d093a5e..09af3d985 100644 --- a/README +++ b/README @@ -1,29 +1,29 @@ # # Copyright 2001-2007,2009,2012 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. -# +# Welcome to GNU Radio! Please see http://gnuradio.org 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. @@ -230,7 +230,7 @@ run some of the example. ---------------------------------------------------------------- -If you have doxygen installed, the build process creates +If you have doxygen installed, the build process creates documentation for the class hierarchy etc. Point your browser at gnuradio/gnuradio-core/doc/html/index.html -- cgit From 62eb0520ba866cc2eb7a4aa3e0ba0cdd325b6c0a Mon Sep 17 00:00:00 2001 From: Tom Rondeau Date: Sun, 22 Apr 2012 20:59:42 -0400 Subject: docs: updating build dependency and building instructions. --- README | 154 +++++------------------------------------------------------------ 1 file changed, 11 insertions(+), 143 deletions(-) (limited to 'README') diff --git a/README b/README index 09af3d985..d8d7e0ebc 100644 --- a/README +++ b/README @@ -46,21 +46,16 @@ http://gnuradio.org/redmine/projects/gnuradio/wiki/DevelopingWithGit How to Build GNU Radio: - (1) Ensure that you've satisfied the external dependencies listed - below. The word "system" is used to mean "operating system - and/or distribution", and means a full operating system, - including kernel, user-space utilties, and a packaging system - for additional software. On Linux, this means what - "distribution" means. - - The following GNU/Linux distributions are known to come with all - required dependencies pre-packaged: Ubuntu >8.10, SuSE 10.0 (the - pay version, not the free download), Fedora Core >9. Other - distribution may work too. We know these three are easy. The - required packages may be contained on your installation CD/DVD, - or may be loaded over the net. The specifics vary depending on - your GNU/Linux distribution. +For more complete instructions, see the "Building GNU Radio" page in +the GNU Radio manual (can be built or found online at +http://gnuradio.org/doc/doxygen/page_build.html). +See these steps fow a quick build guide. + + (1) Ensure that you've satisfied the external dependencies. These + dependencies are listed in the manual's build page and are not + presented here to reduce duplication errors. + On systems using pkgsrc (e.g. NetBSD and Dragonfly), build meta-packages/gnuradio, which will build a previous release and force installation of the dependencies. Then pkg_delete the @@ -105,147 +100,20 @@ with '-O3', which is the default. ------------------------------------------------------------------------------- - External dependencies + NOTES ------------------------------------------------------------------------------- -Prerequisites: Before trying to build these from source, please try -your system's installation tool (apt-get, pkg_install, YaST, yum, -urpmi, etc.) first. Most recent systems have these packages -available. - -You'll need to do a bit of sleuthing to figure out what your OS and -packaging system calls these. If your system uses the convention of -splitting files needed to run programs compiled with foo and files -needed to do the compilation into packages named foo and foo-devel, -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.) - -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) cmake 2.6 or later http://www.cmake.org/cmake/resources/software.html - -(2) pkgconfig 0.15.0 or later http://www.freedesktop.org/Software/pkgconfig - -From the web site: - -pkgconfig is a system for managing library compile/link flags that -works with automake and autoconf. It replaces the ubiquitous *-config -scripts you may have seen with a single tool. - - -(3) FFTW 3.0 or later http://www.fftw.org - -IMPORTANT!!! When building FFTW, you MUST use the --enable-single and ---enable-shared configure options. This builds the single precision -floating point version which we use. You should also use either the ---enable-3dnow or --enable-sse options if you're on an Athlon or Pentium -respectively. - -GNU/Linux packages of single-precision fftw are typically called -fftw3f. - -In systems using pkgsrc, install math/fftwf, which provides the -single-precision libraries. - - -(4) Python 2.5 or later http://www.python.org - -Python 2.5 or later is now required. If your system splits -python into a bunch of separate packages including python-devel or -libpython you'll most likely need those too. - - -(5) Numpy python library http://numeric.scipy.org - -Provides a high performance array type for Python. -http://numpy.scipy.org -http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 - - -(6) The Boost C++ Libraries (1.35 or later) http://www.boost.org - -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. (Note: Mac OSX systems require 1.37 or later.) - - -(7) cppunit 1.9.14 or later. http://cppunit.sourceforge.net - -Unit testing framework for C++. - - -(8) Simple Wrapper Interface Generator. http://www.swig.org - -As of repository version 4045, gnuradio requires version 1.3.31 or newer. - - -(9) GNU Scientific Library (gsl) 1.10 or later - -The GNU Radio core library uses some routines from here. - - -Optional, but nice to have: - -(10) wxPython. Python binding for the wxWidgets GUI framework. Use -version 2.8 or later. Again, almost all systems have this -available. - -As a last resort, build it from source (not recommended!) -http://www.wxpython.org - -(11) xmlto version ? or later. http://cyberelk.net/tim/xmlto/index.html - -Wrapper for XML conversion tools to ease e.g. making html from docbook. - -(12) Python Cheetah extensions 2.0.0 or later -(13) Python lxml wrappers 2.0.0 or later -(14) Python gtk wrappers 2.10.0 or later - -The GNU Radio Companion application requires these additional Python libraries -to be installed. - -The gr-qtgui requires these packages: - -(15) Qt 4.4 or later -(16) Qwt 5.2 or later -(17) PyQt 4.4 or later -(18) PyQwt 5.2 or later - -It is also useful to have Python's Scipy and Matplot lib packages to -run some of the example. - ----------------------------------------------------------------- - -If you have doxygen installed, the build process creates -documentation for the class hierarchy etc. Point your browser at -gnuradio/gnuradio-core/doc/html/index.html - - To run the examples you may need to set PYTHONPATH. Note that the prefix and python version number in the path needs to match your installed version of python. - $ export PYTHONPATH=/usr/local/lib/python2.5/site-packages + $ export PYTHONPATH=/usr/local/lib/python2.7/dist-packages You may want to add this to your shell init file (~/.bash_profile if you use bash). - Another handy trick if for example your fftw includes and libs are installed in, say ~/local/include and ~/local/lib, instead of /usr/local is this: -- cgit