Merge branch 'origin/uhd/readme_fix' into maint

1 files changed, 38 insertions, 0 deletions

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)