summaryrefslogtreecommitdiffstats
path: root/host/docs/index.rst
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-04-19 11:16:21 -0700
committerJosh Blum <josh@joshknows.com>2010-04-19 11:16:21 -0700
commitd4b113cc514b121f696f1693a4ca650950750036 (patch)
tree11a936e4b089790cda98cb4ec688f5b95ed2736c /host/docs/index.rst
parentb3d0c68ceaff1562c32fb8fe41c1e6845a0aad37 (diff)
downloaduhd-d4b113cc514b121f696f1693a4ca650950750036.tar.gz
uhd-d4b113cc514b121f696f1693a4ca650950750036.tar.bz2
uhd-d4b113cc514b121f696f1693a4ca650950750036.zip
added some documentation and links to the index
Diffstat (limited to 'host/docs/index.rst')
-rw-r--r--host/docs/index.rst24
1 files changed, 23 insertions, 1 deletions
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>`_