aboutsummaryrefslogtreecommitdiffstats
path: root/host
diff options
context:
space:
mode:
Diffstat (limited to 'host')
-rw-r--r--host/CMakeLists.txt2
-rw-r--r--host/README.md38
-rw-r--r--host/cmake/Modules/UHDPackage.cmake2
3 files changed, 40 insertions, 2 deletions
diff --git a/host/CMakeLists.txt b/host/CMakeLists.txt
index c45058562..7620d2446 100644
--- a/host/CMakeLists.txt
+++ b/host/CMakeLists.txt
@@ -200,7 +200,7 @@ ADD_CUSTOM_TARGET(uninstall
# Install Package Docs
########################################################################
UHD_INSTALL(FILES
- ${CMAKE_CURRENT_SOURCE_DIR}/../README.md
+ ${CMAKE_CURRENT_SOURCE_DIR}/README.md
${CMAKE_CURRENT_SOURCE_DIR}/LICENSE
DESTINATION ${PKG_DOC_DIR}
COMPONENT readme
diff --git a/host/README.md b/host/README.md
new file mode 100644
index 000000000..e80b10b49
--- /dev/null
+++ b/host/README.md
@@ -0,0 +1,38 @@
+Host UHD™ Software Source Code
+============================================
+
+This directory tree contains the source code that builds the UHD software
+library on your host computer. This library contains the drivers for all Ettus
+Research products, and the framework and API that make them usable to
+application-level programs. The UHD library runs entirely in user-space.
+
+## Documentation
+
+For documentation, please refer to the following resources:
+
+For technical documentation related UHD check out the
+[UHD Manual](http://files.ettus.com/uhd_docs/manual/html/).
+
+If you are looking for API documentation, check out the following resources:
+
+* [Doxygen](http://files.ettus.com/uhd_docs/doxygen/html/index.html)
+* [Coding to the API](http://files.ettus.com/uhd_docs/manual/html/coding.html)
+* [Device Streaming](http://files.ettus.com/uhd_docs/manual/html/stream.html)
+
+Additionally, be sure to check out the Ettus Research
+[FAQ](http://www.ettus.com/kb/detail/frequently-asked-questions), and the
+[Knowledge Base](http://www.ettus.com/kb) for useful application notes and
+tutorials.
+
+## Support
+
+If you have purchased an Ettus Research USRP™ product and need technical support
+using the device or using this UHD™ software, please e-mail the `USRP-Users`
+mailing list, which is where Ettus Research, and our community, provide support
+to users.
+
+Note that you must be *subscribed* to the list in order to post a message to the
+list. This is to prevent spammers from just sending garbage messages out over
+the listserve.
+
+* [Ettus Research USRP-Users Mailing List](http://lists.ettus.com/mailman/listinfo/usrp-users_lists.ettus.com)
diff --git a/host/cmake/Modules/UHDPackage.cmake b/host/cmake/Modules/UHDPackage.cmake
index a98a52fc7..8422c24d6 100644
--- a/host/cmake/Modules/UHDPackage.cmake
+++ b/host/cmake/Modules/UHDPackage.cmake
@@ -99,7 +99,7 @@ SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Ettus Research - USRP Hardware Driver")
SET(CPACK_PACKAGE_VENDOR "Ettus Research LLC")
SET(CPACK_PACKAGE_CONTACT "Ettus Research <support@ettus.com>")
SET(CPACK_PACKAGE_VERSION "${UHD_VERSION}")
-SET(CPACK_RESOURCE_FILE_WELCOME ${CMAKE_SOURCE_DIR}/../README.md)
+SET(CPACK_RESOURCE_FILE_WELCOME ${CMAKE_SOURCE_DIR}/README.md)
SET(CPACK_RESOURCE_FILE_LICENSE ${CMAKE_SOURCE_DIR}/LICENSE)
########################################################################