aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'host/docs/index.rst')
-rw-r--r--host/docs/index.rst32
1 files changed, 32 insertions, 0 deletions
diff --git a/host/docs/index.rst b/host/docs/index.rst
new file mode 100644
index 000000000..b31a3d0ac
--- /dev/null
+++ b/host/docs/index.rst
@@ -0,0 +1,32 @@
+========================================================================
+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
+------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^^^^
+Building the UHD
+^^^^^^^^^^^^^^^^^^^^^
+* `Build Guide <./build.html>`_
+
+^^^^^^^^^^^^^^^^^^^^^
+Application Notes
+^^^^^^^^^^^^^^^^^^^^^
+* `General App Notes <./general.html>`_
+* `USRP2 App Notes <./usrp2.html>`_
+* `Daughterboard App Notes <./dboards.html>`_
+
+^^^^^^^^^^^^^^^^^^^^^
+API Documentation
+^^^^^^^^^^^^^^^^^^^^^
+* `Doxygen <./../../doxygen/html/index.html>`_
+* `Using the API <./coding.html>`_
+