2 # Copyright 2001,2002,2003,2004,2005,2006 Free Software Foundation, Inc.
4 # This file is part of GNU Radio
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)
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.
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., 51 Franklin Street,
19 # Boston, MA 02110-1301, USA.
25 As of August 3, 2006 we have restructured the GNU Radio build process
26 and moved the source code repository from CVS to subversion.
28 Please see http://gnuradio.utah.edu/trac for the wiki, bug tracking,
29 and source code viewer.
31 The bleeding edge code can be found in our subversion repository at
32 http://gnuradio.utah.edu/svn. To checkout the latest, use this
35 $ svn co http://gnuradio.utah.edu/svn/gnuradio/trunk gnuradio
37 For information about subversion, please see:
38 http://subversion.tigris.org/
42 GNU Radio is now distributed as one giant blob, instead of N smaller
43 blobs. We believe that this will reduce some of the build problems
44 people were seeing. Now you'll always get all of the code, and the
45 configure step will determine which components can be built on your
49 How to Build GNU Radio:
51 (1) Ensure that you've satisfied the external dependencies listed
52 below. With the exception of SDCC, the following GNU/Linux
53 distributions are known to come with all required dependencies
54 pre-packaged: Ubuntu 6.06, SuSE 10.0 (the pay version, not the
55 free download), Fedora Core 5. Other distribution may work too.
56 We know these three are easy. The required packages may be
57 contained on your installation CD/DVD, or may be loaded over the
58 net. The specifics vary depending on your GNU/Linux
59 distribution. See the wiki at
60 http://gnuradio.utah.edu/trac/wiki for details.
62 FIXME: update the wiki; talk about OS/X, NetBSD and MinGW too.
64 (2) do the "usual dance"
66 $ ./bootstrap # not reqd when building from the tarball
75 -------------------------------------------------------------------------------
77 KNOWN INCOMPATIBILITIES
80 GNU Radio triggers bugs in g++ 3.3 for X86. DO NOT USE GCC 3.3 on
81 the X86 platform. g++ 3.2, 3.4, and the 4.* series are known to work well.
83 -------------------------------------------------------------------------------
85 -------------------------------------------------------------------------------
89 -------------------------------------------------------------------------------
91 Prerequisites: Before trying to build these from source, please try
92 your installation tool (apt-get, YaST, yum, urpmi, etc.) first.
93 Contemporary distributions have these packages available.
95 You'll need to do a bit of sleuthing to figure out what your OS and
96 packaging system calls these. If your system has both a foo and a
97 foo-devel package, install them both.
102 autoconf 2.57 or later
103 automake 1.7.4 or later
106 If your system has automake-1.4, there's a good chance it also has
107 automake-1.7 or later. Check your install disk and/or try:
109 $ man update-alternatives
111 for info on how some distributions support multiple versions.
114 (2) pkgconfig 0.15.0 or later http://www.freedesktop.org/Software/pkgconfig
118 pkgconfig is a system for managing library compile/link flags that
119 works with automake and autoconf. It replaces the ubiquitous *-config
120 scripts you may have seen with a single tool.
123 (3) FFTW 3.0 or later http://www.fftw.org
125 IMPORTANT!!! When building FFTW, you MUST use the --enable-single and
126 --enable-shared configure options. This builds the single precision
127 floating point version which we use. You should also use either the
128 --enable-3dnow or --enable-sse options if you're on an Athlon or Pentium
132 (4) Python 2.3 or later http://www.python.org
134 Python 2.3 or later is now required. If your distribution splits
135 python into a bunch of separate RPMS including python-devel or
136 libpython you'll most likely need those too.
139 (5) Numeric python library http://numeric.scipy.org
141 Provides a high performance array type for Python.
142 http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=1351
145 (6) The Boost C++ Libraries http://www.boost.org
147 We use the Smart Pointer library. Your distribution almost certainly
148 has the boost libraries available. In the unlikely event that it
149 doesn't, download the source and follow the build instructions.
150 They're different from the normal ./configure && make
153 (7) cppunit 1.9.14 or later. http://cppunit.sourceforge.net
155 Unit testing framework for C++.
158 (8) Simple Wrapper Interface Generator. http://www.swig.org
160 These versions are known to work:
161 1.3.23, 1.3.24, 1.3.25, 1.3.27, 1.3.28, 1.3.29
164 (9) SDCC: Small Device C Compiler. http://sdcc.sourceforge.net/
166 Use version 2.4.0 or later.
168 This includes a C compiler and linker for the 8051. It's required to
169 build the firmware for the USRP. If you don't have a USRP, don't
173 Optional, but nice to have:
175 (10) wxPython. Python binding for the wxWidgets GUI framework.
176 Use version 2.5.2.7 or later. Again, your distribution almost
177 certainly has this available.
179 As a last resort, build it from source (not recommended!)
180 http://www.wxpython.org
183 ----------------------------------------------------------------
185 If you've got doxygen installed and provide the --enable-doxygen
186 configure option, the build process creates documentation for the
187 class hierarchy etc. Point your browser at
188 gnuradio/gnuradio-core/doc/html/index.html
191 To run the examples you'll need to set PYTHONPATH.
192 Note that the python version number in the path needs to match your
193 installed version of python.
195 $ export PYTHONPATH=/usr/local/lib/python2.3/site-packages
197 You may want to add this to your ~/.bash_profile
200 Another handy trick if for example your fftw includes and libs are
201 installed in, say ~/local/include and ~/local/lib, instead of
204 $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/local/lib
205 $ make CPPFLAGS="-I$HOME/local/include"