From 0e3912767266473e08386c910954450d16d33664 Mon Sep 17 00:00:00 2001
From: Ben Hilburn <ben.hilburn@ettus.com>
Date: Wed, 27 Nov 2013 11:53:38 -0800
Subject: Squashed commit uhd/cleanup.

---
 images/Makefile   | 16 ++++++++--------
 images/README.md  | 35 +++++++++++++++++++++++++++++++++++
 images/README.txt | 25 -------------------------
 3 files changed, 43 insertions(+), 33 deletions(-)
 create mode 100644 images/README.md
 delete mode 100644 images/README.txt

(limited to 'images')

diff --git a/images/Makefile b/images/Makefile
index 2e3bcfd26..6b1cfcfc4 100644
--- a/images/Makefile
+++ b/images/Makefile
@@ -117,7 +117,7 @@ $(_usrp_b100_fpga_2rx_bin): $(GLOBAL_DEPS)
 endif
 
 ########################################################################
-# USRP2 and N Series firmware
+# USRP2 and N-Series firmware
 ########################################################################
 ifdef HAS_ZPU_GCC
 
@@ -143,7 +143,7 @@ $(_usrp_n210_fw_bin): $(_usrp2_fw_bin)
 endif
 
 ########################################################################
-# USRP2 fpga
+# USRP2 FPGA
 ########################################################################
 ifdef HAS_XTCLSH
 
@@ -159,7 +159,7 @@ $(_usrp2_fpga_bin): $(GLOBAL_DEPS)
 endif
 
 ########################################################################
-# USRP-N200 R2/R3 fpga
+# USRP N200 R2/R3 FPGA
 ########################################################################
 ifdef HAS_XTCLSH
 
@@ -185,7 +185,7 @@ $(_usrp_n200_r2_fpga_bin): $(_usrp_n200_r3_fpga_bin)
 endif
 
 ########################################################################
-# USRP-N210 R2/R3 fpga
+# USRP N210 R2/R3 FPGA
 ########################################################################
 ifdef HAS_XTCLSH
 
@@ -211,7 +211,7 @@ $(_usrp_n210_r2_fpga_bin): $(_usrp_n210_r3_fpga_bin)
 endif
 
 ########################################################################
-# USRP-N200 R4 fpga
+# USRP N200 R4 FPGA
 ########################################################################
 ifdef HAS_XTCLSH
 
@@ -231,7 +231,7 @@ $(_usrp_n200_r4_fpga_bit): $(_usrp_n200_r4_fpga_bin)
 endif
 
 ########################################################################
-# USRP-N210 R4 fpga
+# USRP N210 R4 FPGA
 ########################################################################
 ifdef HAS_XTCLSH
 
@@ -251,7 +251,7 @@ $(_usrp_n210_r4_fpga_bit): $(_usrp_n210_r4_fpga_bin)
 endif
 
 ########################################################################
-# USRP-E100 fpga
+# USRP E100 FPGA
 ########################################################################
 ifdef HAS_XTCLSH
 
@@ -267,7 +267,7 @@ $(_usrp_e100_fpga_bin): $(GLOBAL_DEPS)
 endif
 
 ########################################################################
-# USRP-E110 fpga
+# USRP E110 FPGA
 ########################################################################
 ifdef HAS_XTCLSH
 
diff --git a/images/README.md b/images/README.md
new file mode 100644
index 000000000..b9e3232aa
--- /dev/null
+++ b/images/README.md
@@ -0,0 +1,35 @@
+UHD Firmware and FPGA Images Builder
+===============================================================
+
+The images directory contains the following:
+* A Makefile for building firmware and FPGA images
+* A CMake file for building an images package
+
+This provides a clean and organized way to build all of the firmware and FPGA
+images, the source code for which is in the `firmware` and `fpga` directories
+one level above this.
+
+The Makefile and build systems for the images are *probably* Unix-specific.
+It's best to build the images on a Unix system with standard build tools.  The
+CMake package target will create an installable images package for your system.
+
+__To build the images (unix):__
+
+1. `make clean`
+2. `make images`
+
+__To build the package (unix):__
+
+1. `mkdir build`
+2. `cd build`
+3. `cmake -DCPACK_GENERATOR=<type> ../`
+4. `make package`
+
+The package generator types are described here:
+http://www.cmake.org/Wiki/CMake:CPackPackageGenerators
+
+__Fedora note:__
+
+The sdcc binaries are prefixed with "sdcc-" which breaks the build.
+However, /usr/libexec/sdcc contains properly named sdcc binaries.
+`export PATH=${PATH}:/usr/libexec/sdcc`
diff --git a/images/README.txt b/images/README.txt
deleted file mode 100644
index 2f9c6a95e..000000000
--- a/images/README.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-The images directory contains the following:
-    - a Makefile for building firmware and fpga images
-    - a CMake file for building an images package
-
-The Makefile and build systems for the images are probably Unix specific.
-Its best to build the images on a Unix system with standard build tools.
-The CMake package target will create an images package for your system.
-
-To build the images (unix):
-    make clean
-    make images
-
-To build the package (unix):
-    mkdir build
-    cd build
-    cmake -DCPACK_GENERATOR=<type> ../
-    make package
-
-The package generator types are described here:
-    http://www.cmake.org/Wiki/CMake:CPackPackageGenerators
-
-Fedora note:
-    The sdcc binaries are prefixed with "sdcc-" which breaks the build.
-    However, /usr/libexec/sdcc contains properly named sdcc binaries.
-    export PATH=${PATH}:/usr/libexec/sdcc
-- 
cgit v1.2.3