From 18b3a5b458ef3b6de3c52c946ef82c06e070dbc4 Mon Sep 17 00:00:00 2001 From: Ben Hilburn Date: Mon, 21 Apr 2014 13:10:17 -0700 Subject: UHD: Introducing Readme.md in host/ --- README.md | 2 +- host/README.md | 39 ++++++++++++++++++++++++++++++++++++++- 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 45903b4b5..791d0c16b 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ USRP Hardware Driver (UHD™) Software Welcome to the UHD™ software distribution! UHD is the free & open-source software driver and API for the Universal Software Radio Peripheral (USRP™) SDR -platform, created and sold by Ettus Research, LLC. +platform, created and sold by Ettus Research. UHD supports all Ettus Research USRP™ hardware, including all motherboards and daughterboards, and the combinations thereof. diff --git a/host/README.md b/host/README.md index 4ee8021cc..e80b10b49 100644 --- a/host/README.md +++ b/host/README.md @@ -1 +1,38 @@ -ghasfdghklasfdasfdhklasfdghklasfdhlasfdlasf +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) -- cgit v1.2.3