summaryrefslogtreecommitdiffstats
path: root/host/docs/build.rst
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2012-03-29 09:00:31 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2012-03-29 09:00:31 -0700
commita67486fff0b75a08072fe66b2c6c314cb4b3a16a (patch)
tree843f0652956b5c08a77f3d68a8700f8f61c583e5 /host/docs/build.rst
parent097f20df1653c33035b6dcfefbbef22572426c65 (diff)
downloaduhd-a67486fff0b75a08072fe66b2c6c314cb4b3a16a.tar.gz
uhd-a67486fff0b75a08072fe66b2c6c314cb4b3a16a.tar.bz2
uhd-a67486fff0b75a08072fe66b2c6c314cb4b3a16a.zip
docs: Adding links to specific installation instructions for Windows and Linux, as well as general formatting consistency/clean-up
Diffstat (limited to 'host/docs/build.rst')
-rw-r--r--host/docs/build.rst52
1 files changed, 26 insertions, 26 deletions
diff --git a/host/docs/build.rst b/host/docs/build.rst
index ee522780a..8a6841af6 100644
--- a/host/docs/build.rst
+++ b/host/docs/build.rst
@@ -20,16 +20,16 @@ Other dependencies can be downloaded as dmg installers from the web.
**Windows Notes:**
The dependencies can be acquired through installable exe files.
-Usually, the windows installer can be found on the project's website.
-Some projects do not host windows installers, and if this is the case,
-follow the auxiliary download url for the windows installer (below).
+Usually, the Windows installer can be found on the project's website.
+Some projects do not host Windows installers, and if this is the case,
+follow the auxiliary download URL for the Windows installer (below).
^^^^^^^^^^^^^^^^
Git
^^^^^^^^^^^^^^^^
Required to check out the repository.
-On windows, install cygwin with git support to checkout the repository,
-or install msysgit from http://code.google.com/p/msysgit/downloads/list
+On Windows, install Cygwin with Git support to checkout the repository,
+or install msysGit from http://code.google.com/p/msysgit/downloads/list
^^^^^^^^^^^^^^^^
C++ compiler
@@ -52,10 +52,10 @@ CMake
Boost
^^^^^^^^^^^^^^^^
* **Purpose:** C++ library
-* **Version:** at least 1.36 unix, at least 1.40 windows
+* **Version:** at least 1.36 (UNIX), at least 1.40 (Windows)
* **Usage:** build time + run time (required)
* **Download URL:** http://www.boost.org/users/download/
-* **Download URL (windows installer):** http://www.boostpro.com/download
+* **Download URL (Windows installer):** http://www.boostpro.com/download
^^^^^^^^^^^^^^^^
LibUSB
@@ -64,7 +64,7 @@ LibUSB
* **Version:** at least 1.0
* **Usage:** build time + run time (optional)
* **Download URL:** http://sourceforge.net/projects/libusb/files/libusb-1.0/
-* **Download URL (windows binaries):** http://www.libusb.org/wiki/windows_backend#LatestBinarySnapshots
+* **Download URL (Windows binaries):** http://www.libusb.org/wiki/windows_backend#LatestBinarySnapshots
^^^^^^^^^^^^^^^^
Python
@@ -81,7 +81,7 @@ Cheetah
* **Version:** at least 2.0
* **Usage:** build time (required)
* **Download URL:** http://www.cheetahtemplate.org/download.html
-* **Download URL (windows installer):** http://feisley.com/python/cheetah/
+* **Download URL (Windows installer):** http://feisley.com/python/cheetah/
**Alternative method:**
Install setuptools, and use the easy_install command to install Cheetah.
@@ -90,14 +90,14 @@ http://pypi.python.org/pypi/setuptools
^^^^^^^^^^^^^^^^
Doxygen
^^^^^^^^^^^^^^^^
-* **Purpose:** generates html api documentation
+* **Purpose:** generates HTML api documentation
* **Usage:** build time (optional)
* **Download URL:** http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc
^^^^^^^^^^^^^^^^
Docutils
^^^^^^^^^^^^^^^^
-* **Purpose:** generates html user manual
+* **Purpose:** generates HTML user manual
* **Usage:** build time (optional)
* **Download URL:** http://docutils.sourceforge.net/
@@ -110,7 +110,7 @@ Build Instructions (Unix)
------------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Generate Makefiles with cmake
+Generate Makefiles with CMake
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
@@ -119,7 +119,7 @@ Generate Makefiles with cmake
cd build
cmake ../
-Additionally, configuration variables can be passed into cmake via the command line.
+Additionally, configuration variables can be passed into CMake via the command line.
The following common-use configuration variables are listed below:
* For a custom install prefix: -DCMAKE_INSTALL_PREFIX=<install-path>
@@ -151,36 +151,36 @@ or add it to /etc/ld.so.conf and make sure to run:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Setup the library path (Mac OS X)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Make sure that libuhd.dylib is in your DYLD_LIBRARY_PATH
+Make sure that libuhd.dylib is in your DYLD_LIBRARY_PATH.
------------------------------------------------------------------------
Build Instructions (Windows)
------------------------------------------------------------------------
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Generate the project with cmake
+Generate the project with CMake
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* Open the cmake gui program.
+* Open the cmake-gui program.
* Set the path to the source code: <uhd-repo-path>/host
* Set the path to the build directory: <uhd-repo-path>/host/build
* Make sure that the paths do not contain spaces.
-* Click configure and select the MSVC compiler.
-* Set the build variables and click configure again.
-* Click generate and a project file will be created in the build directory.
+* Click "Configure" and select "Microsoft Visual Studio 10".
+* Set the build variables and click "Configure" again.
+* Click "Generate", and a project file will be created in the build directory.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-LibUSB cmake notes
+LibUSB CMake notes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-On Windows, cmake does not have the advantage of pkg-config,
-so we must manually tell cmake how to locate the LibUSB header and lib.
+On Windows, CMake does not have the advantage of pkg-config,
+so we must manually tell CMake how to locate the LibUSB header and lib.
-* From the cmake gui, select "Advanded View"
+* From the CMake GUI, select "Advanced View".
* Set LIBUSB_INCLUDE_DIRS to the directory with "libusb.h".
* Set LIBUSB_LIBRARIES to the full path for "libusb-1.0.lib".
* Recommend the static libusb-1.0.lib to simplify runtime dependencies.
-* Check the box to enable USB support, click configure and generate.
+* Check the box to enable USB support, click "Configure" and "Generate".
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Build the project in MSVC
@@ -206,11 +206,11 @@ Open the Visual Studio Command Prompt Shorcut:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Setup the PATH environment variable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* Add the uhd bin path to %PATH% (usually c:\\program files\\uhd\\bin)
+* Add the UHD bin path to %PATH% (usually c:\\program files\\uhd\\bin)
**Note:**
The interface for editing environment variable paths in Windows is very poor.
-I recommend using "Rapid Environment Editor" (http://www.rapidee.com) over the default editor.
+We recommend using "Rapid Environment Editor" (http://www.rapidee.com) over the default editor.
------------------------------------------------------------------------
Post-Install Tasks