diff options
| -rw-r--r-- | README | 139 | ||||
| -rw-r--r-- | README.md | 108 | ||||
| -rw-r--r-- | cmake/Modules/GrPackage.cmake | 6 | ||||
| -rw-r--r-- | docs/gnuradio.png | bin | 0 -> 86432 bytes |
4 files changed, 111 insertions, 142 deletions
diff --git a/README b/README deleted file mode 100644 index f460dd76ab..0000000000 --- a/README +++ /dev/null @@ -1,139 +0,0 @@ -# -# 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. - -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: -http://gnuradio.org/redmine/projects/gnuradio/wiki/BuildGuide - - -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: - - $ git clone git://git.gnuradio.org/gnuradio - -For information about using Git, please see: -http://gnuradio.org/redmine/projects/gnuradio/wiki/DevelopingWithGit - - -How to Build GNU Radio: - -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/build_guide.html). - -See these steps for 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. - - See the wiki at http://gnuradio.org for details. - - - (2) Building from cmake: - - $ mkdir $(builddir) - $ cd $(builddir) - $ cmake [OPTIONS] $(srcdir) - $ make - $ make test - $ 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. - - -------------------------------------------------------------------------------- - - KNOWN INCOMPATIBILITIES - - - 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. - -------------------------------------------------------------------------------- - -------------------------------------------------------------------------------- - - NOTES - -------------------------------------------------------------------------------- - -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.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: - - $ 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 - - -------------------------------------------------------------------------------- - - 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. - diff --git a/README.md b/README.md new file mode 100644 index 0000000000..eabc72e9c1 --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +<p align="center"> +<img src="https://github.com/gnuradio/gnuradio/blob/master/docs/gnuradio.png" width="75%" /> +</p> + +[](https://github.com/gnuradio/gnuradio/blob/master/COPYING) +[](https://gnuradio.org/doc/doxygen/) + +GNU Radio is a free & open-source software development toolkit that +provides signal processing blocks to implement software radios. It can +be used with readily-available, low-cost external RF hardware to create +software-defined radios, or without hardware in a simulation-like +environment. It is widely used in hobbyist, academic, and commercial +environments to support both wireless communications research and real-world +radio systems. + +Please visit the GNU Radio website at https://gnuradio.org/ and the +wiki at https://wiki.gnuradio.org/. Bugs and feature requests are +tracked on GitHub's [Issue Tracker](https://github.com/gnuradio/gnuradio/issues). +If you have questions about GNU Radio, please search the **discuss-gnuradio** +mailing list [archive](https://lists.gnu.org/archive/html/discuss-gnuradio/), +as many questions have already been asked and answered. Please also +[subscribe](https://lists.gnu.org/mailman/listinfo/discuss-gnuradio) to +the mailing list and post your new questions there. + + +## How to Build GNU Radio + +### PyBOMBS +PyBOMBS (Python Build Overlay Managed Bundle System) is the recommended +method for building and installing GNU Radio. Please see +https://github.com/gnuradio/pybombs for detailed instructions. Abbreviated +instructions are duplicated below. + +1. Install PyBOMBS: + ``` + $ [sudo] pip install PyBOMBS + ``` + or + ``` + $ git clone https://github.com/gnuradio/pybombs.git + $ cd pybombs + $ sudo python setup.py install + ``` + +2. Add PyBOMBS recipes: + ``` + $ pybombs recipes add gr-recipes git+https://github.com/gnuradio/gr-recipes.git + $ pybombs recipes add gr-etcetera git+https://github.com/gnuradio/gr-etcetera.git + ``` + +3. Configure an installation prefix: + ``` + $ pybombs prefix init ~/prefix/default/ + ``` + +4. Install GNU Radio: + ``` + $ pybombs install gnuradio + ``` + +5. Run GNU Radio Companion from your new prefix: + ``` + $ source ~/prefix/default/setup_env.sh + $ gnuradio-companion + ``` + or execute it without changing the current environment + ``` + $ pybombs run gnuradio-companion + ``` + +### Manual Source Build +Complete build instructions are detailed in the +[GNU Radio Build Guide](https://gnuradio.org/doc/doxygen/build_guide.html). +Abbreviated instructions are duplicated below. + +1. Ensure that you have satisfied the external dependencies, see +[GNU Radio Dependencies](https://gnuradio.org/doc/doxygen/build_guide.html). + +2. Checkout the latest code: + ``` + $ git clone https://github.com/gnuradio/gnuradio.git + ``` + +3. Build with CMake: + ``` + $ cd gnuradio + $ mkdir build + $ cd build + $ cmake [OPTIONS] ../ + $ make + $ make test + $ sudo make install + ``` + Useful `[OPTIONS]` include setting the install prefix + `-DCMAKE_INSTALL_PREFIX=<directory to install to>` and the build type + `-DCMAKE_BUILD_TYPE=<type>`. Currently, GNU Radio has a `"Debug"` type + that builds with `-g -O2` which is useful for debugging the software, + and a `"Release"` type that builds with `-O3`, which is the default. + + +## Legal Matters + +Some files have been changed many times throughout the years. Copyright +notices at the top of source 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. diff --git a/cmake/Modules/GrPackage.cmake b/cmake/Modules/GrPackage.cmake index 54a752661d..7fa566f795 100644 --- a/cmake/Modules/GrPackage.cmake +++ b/cmake/Modules/GrPackage.cmake @@ -104,9 +104,9 @@ set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "GNU Radio - The GNU Software Radio") set(CPACK_PACKAGE_VENDOR "Free Software Foundation, Inc.") set(CPACK_PACKAGE_CONTACT "Discuss GNURadio <discuss-gnuradio@gnu.org>") string(REPLACE "v" "" CPACK_PACKAGE_VERSION ${VERSION}) -set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_SOURCE_DIR}/README) -set(CPACK_RESOURCE_FILE_README ${CMAKE_SOURCE_DIR}/README) -set(CPACK_RESOURCE_FILE_WELCOME ${CMAKE_SOURCE_DIR}/README) +set(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_SOURCE_DIR}/README.md) +set(CPACK_RESOURCE_FILE_README ${CMAKE_SOURCE_DIR}/README.md) +set(CPACK_RESOURCE_FILE_WELCOME ${CMAKE_SOURCE_DIR}/README.md) find_program(LSB_RELEASE_EXECUTABLE lsb_release) diff --git a/docs/gnuradio.png b/docs/gnuradio.png Binary files differnew file mode 100644 index 0000000000..64fac3cfbd --- /dev/null +++ b/docs/gnuradio.png |
