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.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/host/docs/index.rst b/host/docs/index.rst
new file mode 100644
index 000000000..00b1c9618
--- /dev/null
+++ b/host/docs/index.rst
@@ -0,0 +1,42 @@
+========================================================================
+UHD - USRP Hardware Driver
+========================================================================
+
+UHD is the "Universal Software Radio Peripheral" hardware driver.
+The goal of 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 or with third-party applications.
+
+------------------------------------------------------------------------
+Contents
+------------------------------------------------------------------------
+
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Building and Installing UHD
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* `Build Guide <./build.html>`_
+* `Installation Guide (Linux) <http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Linux>`_
+* `Installation Guide (Windows) <http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Windows>`_
+
+^^^^^^^^^^^^^^^^^^^^^
+Application Notes
+^^^^^^^^^^^^^^^^^^^^^
+* `General Application Notes <./general.html>`_
+* `Device Identification Notes <./identification.html>`_
+* `Firmware and FPGA Image Notes <./images.html>`_
+* `USRP1 Application Notes <./usrp1.html>`_
+* `USRP2 Application Notes <./usrp2.html>`_
+* `USRP-N2X0 Series Application Notes <./usrp2.html>`_
+* `USRP-B100 Series Application Notes <./usrp_b100.html>`_
+* `USRP-E1X0 Series Application Notes <./usrp_e1x0.html>`_
+* `Daughterboard Application Notes <./dboards.html>`_
+* `Transport Application Notes <./transport.html>`_
+* `Synchronization Application Notes <./sync.html>`_
+* `Internal GPSDO Application Notes <./gpsdo.html>`_
+* `Calibration Application Notes <./calibration.html>`_
+
+^^^^^^^^^^^^^^^^^^^^^
+API Documentation
+^^^^^^^^^^^^^^^^^^^^^
+* `Doxygen <./../../doxygen/html/index.html>`_
+* `Using the API <./coding.html>`_
+* `Device Streaming <./stream.html>`_