summaryrefslogtreecommitdiffstats
path: root/host/docs/index.rst
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-04-19 11:17:42 -0700
committerJosh Blum <josh@joshknows.com>2010-04-19 11:17:42 -0700
commit5ae48902712912456307772b372a50c89791cab3 (patch)
treec8925d7be05ac0646eb433884d32dec3cd2c9fd9 /host/docs/index.rst
parent154e4492485eb2e56bf5fc1372670540e2f44090 (diff)
parentd4b113cc514b121f696f1693a4ca650950750036 (diff)
downloaduhd-5ae48902712912456307772b372a50c89791cab3.tar.gz
uhd-5ae48902712912456307772b372a50c89791cab3.tar.bz2
uhd-5ae48902712912456307772b372a50c89791cab3.zip
Merge branch 'docs' into work
Diffstat (limited to 'host/docs/index.rst')
-rw-r--r--host/docs/index.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/host/docs/index.rst b/host/docs/index.rst
new file mode 100644
index 000000000..51dba26b5
--- /dev/null
+++ b/host/docs/index.rst
@@ -0,0 +1,28 @@
+========================================================================
+UHD - Universal Hardware Driver
+========================================================================
+
+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>`_