aboutsummaryrefslogtreecommitdiffstats
path: root/host/examples/init_usrp/README
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2014-09-25 16:01:05 -0700
committerMartin Braun <martin.braun@ettus.com>2014-09-25 16:01:05 -0700
commita1767ede3c147c1748c6a33a52469d0cba644bf5 (patch)
tree94948fe7bf97baa404b9e96a37de8a73fe1da0be /host/examples/init_usrp/README
parent6c8cd94f1419458713543ada013f6b2413afc183 (diff)
downloaduhd-a1767ede3c147c1748c6a33a52469d0cba644bf5.tar.gz
uhd-a1767ede3c147c1748c6a33a52469d0cba644bf5.tar.bz2
uhd-a1767ede3c147c1748c6a33a52469d0cba644bf5.zip
uhd: Added an example for CMake usage
Diffstat (limited to 'host/examples/init_usrp/README')
-rw-r--r--host/examples/init_usrp/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/host/examples/init_usrp/README b/host/examples/init_usrp/README
new file mode 100644
index 000000000..c231ce0d8
--- /dev/null
+++ b/host/examples/init_usrp/README
@@ -0,0 +1,20 @@
+Building UHD Applications using CMake
+=====================================
+
+This directory contains a tiny example of a UHD-based application.
+Unlike the other examples, it is completely independent of the UHD
+source tree and can be compiled from any path as long as UHD is
+currently installed on the current machine.
+
+To try it out, run these commands:
+$ mkdir build/ # Creates a new build directory
+$ cd build/
+$ cmake ..
+$ make
+
+This will find the UHD libraries, and link and compile the example
+program. Include header directories and library names are automatically
+gathered.
+
+See the CMakeLists.txt file to figure out how to set up a build system.
+