Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 140 lines (92 sloc) 4.549 kb
5d69a52 Houston, we have a trunk.
jcorgan authored
1 #
6d20c58 Tom Rondeau docs: updating README files for working with cmake.
trondeau authored
2 # Copyright 2001-2007,2009,2012 Free Software Foundation, Inc.
f919f9d Tom Rondeau Removed whitespace and added dtools/bin/remove-whitespace as a tool to d...
trondeau authored
3 #
5d69a52 Houston, we have a trunk.
jcorgan authored
4 # This file is part of GNU Radio
f919f9d Tom Rondeau Removed whitespace and added dtools/bin/remove-whitespace as a tool to d...
trondeau authored
5 #
5d69a52 Houston, we have a trunk.
jcorgan authored
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
937b719 Updated license from GPL version 2 or later to GPL version 3 or later.
eb authored
8 # the Free Software Foundation; either version 3, or (at your option)
5d69a52 Houston, we have a trunk.
jcorgan authored
9 # any later version.
f919f9d Tom Rondeau Removed whitespace and added dtools/bin/remove-whitespace as a tool to d...
trondeau authored
10 #
5d69a52 Houston, we have a trunk.
jcorgan authored
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.
f919f9d Tom Rondeau Removed whitespace and added dtools/bin/remove-whitespace as a tool to d...
trondeau authored
15 #
5d69a52 Houston, we have a trunk.
jcorgan authored
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
86f5c92 Updated FSF address in all files. Fixes ticket:51
eb authored
18 # the Free Software Foundation, Inc., 51 Franklin Street,
19 # Boston, MA 02110-1301, USA.
f919f9d Tom Rondeau Removed whitespace and added dtools/bin/remove-whitespace as a tool to d...
trondeau authored
20 #
5d69a52 Houston, we have a trunk.
jcorgan authored
21
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
22 Welcome to GNU Radio!
23
24
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
25 Please see http://gnuradio.org for the wiki, bug tracking,
f919f9d Tom Rondeau Removed whitespace and added dtools/bin/remove-whitespace as a tool to d...
trondeau authored
26 and source code viewer.
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
27
28 If you've got questions about GNU Radio, please subscribe to the
29 discuss-gnuradio mailing list and post your questions there.
30 http://gnuradio.org/redmine/projects/gnuradio/wiki/MailingLists
31
e7083c3 doc cleanup
eb authored
32 There is also a "Build Guide" in the wiki that contains OS specific
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
33 recommendations:
34 http://gnuradio.org/redmine/projects/gnuradio/wiki/BuildGuide
e7083c3 doc cleanup
eb authored
35
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
36
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
37 The bleeding edge code can be found in our git repository at
38 http://gnuradio.org/git/gnuradio.git/. To checkout the latest, use
39 this command:
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
40
fbd0fe3 Johnathan Corgan Clean up text docs.
jmcorgan authored
41 $ git clone git://git.gnuradio.org/gnuradio
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
42
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
43 For information about using Git, please see:
44 http://gnuradio.org/redmine/projects/gnuradio/wiki/DevelopingWithGit
5d69a52 Houston, we have a trunk.
jcorgan authored
45
46
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
47 How to Build GNU Radio:
48
62eb052 Tom Rondeau docs: updating build dependency and building instructions.
trondeau authored
49 For more complete instructions, see the "Building GNU Radio" page in
50 the GNU Radio manual (can be built or found online at
51 http://gnuradio.org/doc/doxygen/page_build.html).
15698af general cleanup:
gdt authored
52
62eb052 Tom Rondeau docs: updating build dependency and building instructions.
trondeau authored
53 See these steps fow a quick build guide.
54
55 (1) Ensure that you've satisfied the external dependencies. These
56 dependencies are listed in the manual's build page and are not
57 presented here to reduce duplication errors.
58
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
59 See the wiki at http://gnuradio.org for details.
60
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
61
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
62 (2) Building from cmake:
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
63
29299eb Tom Rondeau docs: updating documentation. More build instructions/information in Dox...
trondeau authored
64 $ mkdir $(builddir)
65 $ cd $(builddir)
66 $ cmake [OPTIONS] $(srcdir)
67 $ make
68 $ make test
6d20c58 Tom Rondeau docs: updating README files for working with cmake.
trondeau authored
69 $ sudo make install
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
70
71
72 That's it!
5d69a52 Houston, we have a trunk.
jcorgan authored
73
6d20c58 Tom Rondeau docs: updating README files for working with cmake.
trondeau authored
74 Options:
75 Useful options include setting the install prefix and the build type:
76
77 -DCMAKE_INSTALL_PREFIX=<directory to install to>
78 -DCMAKE_BUILD_TYPE="<type>"
79
80 Currently, GNU Radio has a "Debug" type that builds with '-g -O2'
81 useful for debugging the software and a "Release" type that builds
82 with '-O3', which is the default.
83
5d69a52 Houston, we have a trunk.
jcorgan authored
84
85 -------------------------------------------------------------------------------
86
87 KNOWN INCOMPATIBILITIES
88
89
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
90 GNU Radio triggers bugs in g++ 3.3 for X86. DO NOT USE GCC 3.3 on
91 the X86 platform. g++ 3.2, 3.4, and the 4.* series are known to work well.
5d69a52 Houston, we have a trunk.
jcorgan authored
92
93 -------------------------------------------------------------------------------
94
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
95 -------------------------------------------------------------------------------
96
62eb052 Tom Rondeau docs: updating build dependency and building instructions.
trondeau authored
97 NOTES
559f82a Cleaned up top-level README, and fixed or deleted lower level ones as
eb authored
98
99 -------------------------------------------------------------------------------
100
4c84464 Updated README for gsl and GRC
jcorgan authored
101 To run the examples you may need to set PYTHONPATH. Note that the
15698af general cleanup:
gdt authored
102 prefix and python version number in the path needs to match your
5d69a52 Houston, we have a trunk.
jcorgan authored
103 installed version of python.
104
62eb052 Tom Rondeau docs: updating build dependency and building instructions.
trondeau authored
105 $ export PYTHONPATH=/usr/local/lib/python2.7/dist-packages
5d69a52 Houston, we have a trunk.
jcorgan authored
106
15698af general cleanup:
gdt authored
107 You may want to add this to your shell init file (~/.bash_profile if
108 you use bash).
5d69a52 Houston, we have a trunk.
jcorgan authored
109
6105af5 Added note about how to work around Fedora Core PYTHONPATH weirdness on ...
eb authored
110
5d69a52 Houston, we have a trunk.
jcorgan authored
111 Another handy trick if for example your fftw includes and libs are
112 installed in, say ~/local/include and ~/local/lib, instead of
113 /usr/local is this:
114
115 $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/local/lib
116 $ make CPPFLAGS="-I$HOME/local/include"
15698af general cleanup:
gdt authored
117
118
119 Sometimes the prerequisites are installed in a location which is not
120 included in the default compiler and linker search paths. This
121 happens with pkgsrc and NetBSD. To build, tell configure to use these
122 locations:
123
124 LDFLAGS="-L/usr/pkg/lib -R/usr/pkg/lib" CPPFLAGS="-I/usr/pkg/include" ./configure --prefix=/usr/gnuradio
4c84464 Updated README for gsl and GRC
jcorgan authored
125
bd8dd84 Tom Rondeau Adding required legal notice of what a copyright year range means that i...
trondeau authored
126
127 -------------------------------------------------------------------------------
128
129 Legal Matters
130
131 -------------------------------------------------------------------------------
132
133 Some files have been changed many times throughout the
134 years. Copyright notices at the tops of these files list which years
135 changes have been made. For some files, changes have occurred in many
136 consecutive years. These files may often have the format of a year
137 range (e.g., "2006 - 2011"), which indicates that these files have had
138 copyrightable changes made during each year in the range, inclusive.
1864683 Tom Rondeau testing something.
trondeau authored
139
Something went wrong with that request. Please try again.