diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 91 |
1 files changed, 43 insertions, 48 deletions
@@ -1,29 +1,29 @@ # -# 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 -# +# # 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. @@ -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=<directory to install to> + -DCMAKE_BUILD_TYPE="<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,44 @@ 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 - -Scheme interpreter. http://www.gnu.org/software/guile/guile.html - - -(11) 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: -(12) 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 -(13) 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. -(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 +(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'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 |