summaryrefslogtreecommitdiffstats
path: root/host/docs/images.rst
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2012-03-29 14:47:54 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2012-03-29 14:47:54 -0700
commitd1ad808f78497db2770a346d560c9a7f21ff1f1f (patch)
tree0bf27335a10927460f4a2c5747c8e74f64c9bdc9 /host/docs/images.rst
parenta67486fff0b75a08072fe66b2c6c314cb4b3a16a (diff)
downloaduhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.tar.gz
uhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.tar.bz2
uhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.zip
docs: Format consistency, such as representation of program names or filepaths
Diffstat (limited to 'host/docs/images.rst')
-rw-r--r--host/docs/images.rst47
1 files changed, 27 insertions, 20 deletions
diff --git a/host/docs/images.rst b/host/docs/images.rst
index 78280bac0..eaddfdf1d 100644
--- a/host/docs/images.rst
+++ b/host/docs/images.rst
@@ -17,10 +17,15 @@ The methods of loading images into the device vary among devices:
* **USRP-B Series:** The host code will automatically load the FPGA at runtime.
------------------------------------------------------------------------
-Pre-built images
+Pre-built Images
------------------------------------------------------------------------
Pre-built images are available for download.
+
+* `Master Branch images <http://files.ettus.com/binaries/master_images/>`_
+* `Maint Branch images <http://files.ettus.com/binaries/maint_images/>`_
+* `Next Branch images <http://files.ettus.com/binaries/next_images/>`_
+
See the UHD wiki for the download link.
The pre-built images come in two forms:
@@ -31,8 +36,9 @@ The pre-built images come in two forms:
^^^^^^^^^^^^^^^^^^^^^^
Platform installers
^^^^^^^^^^^^^^^^^^^^^^
-The UNIX-based installers will install the images into /usr/share/uhd/images.
-On Windows, the images will be installed to <install-path>/share/uhd/images.
+The UNIX-based installers will install the images into **/usr/share/uhd/images**.
+
+The Windows installers will install the images into **C:/Program Files/UHD/share/uhd/images**.
^^^^^^^^^^^^^^^^^^^^^^
Archive install
@@ -42,52 +48,53 @@ When installing images from an archive, there are two options:
**Option 1:**
Unpack the archive into the UHD installation prefix.
-The UHD will always search <install-path>/share/uhd/images for image files.
-Where <install-path> was set by the CMAKE_INSTALL_PREFIX at configure-time.
+UHD will always search **<install-path>/share/uhd/images** for image files.
+Where **<install-path>** was set by the **CMAKE_INSTALL_PREFIX** at configure-time.
**Option 2:**
-Unpack the archive anywhere and set the UHD_IMAGE_PATH environment variable.
-The UHD_IMAGE_PATH may contain a list of directories to search for image files.
+Unpack the archive anywhere and set the **UHD_IMAGES_PATH** environment variable.
+**UHD_IMAGES_PATH** may contain a list of directories to search for image files.
------------------------------------------------------------------------
-Building images
+Building Images
------------------------------------------------------------------------
The UHD source repository comes with the source code necessary to build
both firmware and FPGA images for all supported devices.
-The build commands for a particular image can be found in <uhd-repo-path>/images/Makefile.
+
+The build commands for a particular image can be found in **<uhd-repo-path>/images/Makefile**.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Xilinx FPGA builds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Xilinx ISE 12.x and up is required to build the Xilinx FPGA images.
-The build requires that you have a UNIX-like environment with make.
-Make sure that xtclsh from the Xilinx ISE bin directory is in your $PATH.
+The build requires that you have a UNIX-like environment with **Make**.
+Make sure that **xtclsh** from the Xilinx ISE bin directory is in your **$PATH**.
-See <uhd-repo-path>/fpga/usrp2/top/*
+See **<uhd-repo-path>/fpga/usrp2/top/**.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ZPU firmware builds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The ZPU GCC compiler is required to build the ZPU firmware images.
-The build requires that you have a unix-like environment with cmake and make.
-Make sure that zpu-elf-gcc is in your $PATH.
+The build requires that you have a UNIX-like environment with **CMake** and **Make**.
+Make sure that **zpu-elf-gcc** is in your **$PATH**.
-See <uhd-repo-path>/firmware/zpu
+See **<uhd-repo-path>/firmware/zpu**.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Altera FPGA builds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Quartus is required to build the Altera FPGA images.
-Pre-built images can also be found in <uhd-repo-path>/fpga/usrp1/rbf
+Pre-built images can also be found in **<uhd-repo-path>/fpga/usrp1/rbf**.
-See <uhd-repo-path>/fpga/usrp1/toplevel/*
+See **<uhd-repo-path>/fpga/usrp1/toplevel/***.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FX2 firmware builds
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The sdcc compiler is required to build the FX2 firmware images.
-The build requires that you have a unix-like environment with cmake and make.
+The SDCC compiler is required to build the FX2 firmware images.
+The build requires that you have a UNIX-like environment with **CMake** and **Make**.
-See <uhd-repo-path>/firmware/fx2
+See **<uhd-repo-path>/firmware/fx2**.