diff options
Diffstat (limited to 'host/docs/mainpage.dox.in')
| -rw-r--r-- | host/docs/mainpage.dox.in | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/host/docs/mainpage.dox.in b/host/docs/mainpage.dox.in new file mode 100644 index 000000000..428650633 --- /dev/null +++ b/host/docs/mainpage.dox.in @@ -0,0 +1,29 @@ +/*! \mainpage Table Of Contents + +Welcome to the USRP Hardware Driver (UHD) manual. Here, you will find information on how to use the devices and how to use the API to connect to them through your own software. + +This manual is split into two parts: The device manual, and the UHD/API manual. The first part describes details of our devices, mainboards and daughterboards, as well as aspects of _using_ UHD. + +The second is meant for developers writing UHD-based applications, and includes descriptions of the API, sorted by namespaces, classes and files. + +Follow these links to get to the section of the manual you wish to consult, or use the browser in the left sidebar. A search bar is also available at the top right, but note that this only works on API components. For information on how to build and install UHD, go to the UHD web site (see below). + +## Manual Parts + +\li \subpage page_devices "Part I: Devices & Usage Manual" +\li \subpage page_uhd "Part II: UHD Development Manual" +\li @DOXYGEN_FPGA_MANUAL_REFERENCE@ + +### Further Information + +\li <a href="http://www.ettus.com/">Ettus Research LLC Website</a> +\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/">UHD Wiki Page</a> + +### Building and Installing UHD + +\li \subpage page_build_guide +\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Linux">Installation Guide (Linux)</a> +\li <a href="http://code.ettus.com/redmine/ettus/projects/uhd/wiki/UHD_Windows">Installation Guide (Windows)</a> + +*/ +// vim:ft=doxygen: |