From d4b113cc514b121f696f1693a4ca650950750036 Mon Sep 17 00:00:00 2001 From: Josh Blum Date: Mon, 19 Apr 2010 11:16:21 -0700 Subject: added some documentation and links to the index --- host/docs/index.rst | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) (limited to 'host') diff --git a/host/docs/index.rst b/host/docs/index.rst index f71b0d453..51dba26b5 100644 --- a/host/docs/index.rst +++ b/host/docs/index.rst @@ -2,5 +2,27 @@ UHD - Universal Hardware Driver ======================================================================== -* `Build Guide <./build.html>`_ +The UHD is the universal hardware driver for Ettus Research products. +The goal of the UHD is to provide a host driver and api for current and future Ettus Research products. +Users will be able to use the UHD driver standalone/without gnuradio. +Also, a dual license option will be available for those who build against the UHD +but cannot release their software products under the GPL. + +------------------------------------------------------------------------ +Contents +------------------------------------------------------------------------ + +^^^^^^^^^^^^^^^^^^^^^ +API Documentation +^^^^^^^^^^^^^^^^^^^^^ +* `Doxygen <./../../doxygen/html/index.html>`_ + +^^^^^^^^^^^^^^^^^^^^^ +Supported Devices +^^^^^^^^^^^^^^^^^^^^^ * `USRP2 App Notes <./usrp2.html>`_ + +^^^^^^^^^^^^^^^^^^^^^ +Building the UHD +^^^^^^^^^^^^^^^^^^^^^ +* `Build Guide <./build.html>`_ -- cgit v1.2.3