summaryrefslogtreecommitdiff
path: root/docs/doxygen
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2017-03-26 18:19:48 -0700
committerMartin Braun <martin.braun@ettus.com>2017-03-26 18:19:48 -0700
commit4873481d34f39948ef956d8bb12f6de13aba5b89 (patch)
treee89cc02c6d1c3a9f35c7e6b22d6d2f4cbec3b478 /docs/doxygen
parent99d24d23e95ea0235a8ea2957c289461625765a3 (diff)
parentbcf47d4936f6f24175731f5e4c28a42f3d5de701 (diff)
Merge branch 'min_deps_master' into min_deps_next
Diffstat (limited to 'docs/doxygen')
-rw-r--r--docs/doxygen/CMakeLists.txt4
-rw-r--r--docs/doxygen/other/build_guide.dox.in (renamed from docs/doxygen/other/build_guide.dox)34
2 files changed, 26 insertions, 12 deletions
diff --git a/docs/doxygen/CMakeLists.txt b/docs/doxygen/CMakeLists.txt
index d22f9d9f62..83a9ee29ed 100644
--- a/docs/doxygen/CMakeLists.txt
+++ b/docs/doxygen/CMakeLists.txt
@@ -34,6 +34,10 @@ configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
@ONLY)
+configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/other/build_guide.dox.in
+ ${CMAKE_CURRENT_BINARY_DIR}/other/build_guide.dox
+@ONLY)
set(BUILT_DIRS ${CMAKE_CURRENT_BINARY_DIR}/xml ${CMAKE_CURRENT_BINARY_DIR}/html)
diff --git a/docs/doxygen/other/build_guide.dox b/docs/doxygen/other/build_guide.dox.in
index bbcb7c7d4a..d729e19976 100644
--- a/docs/doxygen/other/build_guide.dox
+++ b/docs/doxygen/other/build_guide.dox.in
@@ -16,8 +16,8 @@ if any, to build the various GNU Radio components.
Most of these components do not need to be individually compiled or
installed. Instead, rely on your operating system's package manager or
-binary installation process (the <b>apt-get</b> system in Debian and
-Ubuntu, <b>yum</b> in RedHat and Fedora, etc.). GNU Radio tries to keep an
+binary installation process (the <b>apt-get</b> or \b apt system in Debian and
+Ubuntu, <b>yum</b> or \b dnf in RedHat and Fedora, etc.). GNU Radio tries to keep an
up-to-date build guide for the majority of the supported operating
systems on gnuradio.org
(http://gnuradio.org/redmine/projects/gnuradio/wiki/BuildGuide).
@@ -33,17 +33,24 @@ installation tool (apt-get, pkg_install, YaST, yum, urpmi, etc.)
first. Most recent systems have these packages available.
\subsection dep_global Global Dependencies
-\li git http://git-scm.com/downloads
-\li cmake (>= 2.6.3) http://www.cmake.org/cmake/resources/software.html
-\li boost (>= 1.35) http://www.boost.org/users/download/
-\li cppunit (>= 1.9.14) http://freedesktop.org/wiki/Software/cppunit/
-\li fftw3f (>= 3.0.1) http://www.fftw.org/download.html
-\li mako (>= 0.4.2) http://www.makotemplates.org/download.html
+
+\li git http://git-scm.com/downloads
+\li cmake (>= @GR_CMAKE_MIN_VERSION@) http://www.cmake.org/cmake/resources/software.html
+\li boost (>= @GR_BOOST_MIN_VERSION@) http://www.boost.org/users/download/
+\li cppunit (>= @GR_CPPUNIT_MIN_VERSION@) http://freedesktop.org/wiki/Software/cppunit/
+\li mako (>= @GR_MAKO_MIN_VERSION@) http://www.makotemplates.org/download.html
+
+A C/C++ compiler is also required. These are known to work:
+
+\li gcc/g++ (>= @GCC_MIN_VERSION@) https://gcc.gnu.org/install/download.html
+\li clang/clang++ (>= @CLANG_MIN_VERSION@) http://releases.llvm.org/download.html
+
+Other compilers may work, but are not supported.
\subsection dep_python Python Wrappers
-\li python (>= 2.5) http://www.python.org/download/
-\li swig (>= 1.3.31) http://www.swig.org/download.html
-\li numpy (>= 1.1.0) http://sourceforge.net/projects/numpy/files/NumPy/
+\li python (>= @GR_PYTHON_MIN_VERSION@) http://www.python.org/download/
+\li swig (>= @GR_SWIG_MIN_VERSION@) http://www.swig.org/download.html
+\li numpy (>= 1.1.0) http://sourceforge.net/projects/numpy/files/NumPy/
\subsection dep_docs docs: Building the documentation
\li doxygen (>= 1.5) http://www.stack.nl/~dimitri/doxygen/download.html
@@ -53,6 +60,9 @@ first. Most recent systems have these packages available.
\li Cheetah (>= 2.0) http://www.cheetahtemplate.org/
\li pygtk (>= 2.10) http://www.pygtk.org/downloads.html
+\subsection dep_fft gr-fft: Fast Frequency Transform
+\li fftw3f (>= 3.0.1) http://www.fftw.org/download.html
+
\subsection dep_wavelet gr-wavelet: Collection of wavelet blocks
\li gsl (>= 1.10) http://gnuwin32.sourceforge.net/packages/gsl.htm
@@ -78,7 +88,7 @@ one(s) that are right for your system. On Linux, don't expect
audio-osx and audio-windows to be either satisfied or built.
\subsection dep_uhd uhd: The Ettus USRP Hardware Driver Interface
-\li uhd (>= 3.0.0) http://code.ettus.com/redmine/ettus/projects/uhd/wiki
+\li uhd (>= 3.5.5) https://www.ettus.com/downloads
\subsection dep_gr_video_sdl gr-video-sdl: PAL and NTSC display
\li SDL (>= 1.2.0) http://www.libsdl.org/download-1.2.php