summaryrefslogtreecommitdiffstats
path: root/host/README
diff options
context:
space:
mode:
authorJosh Blum <josh@joshknows.com>2010-04-19 18:37:05 -0700
committerJosh Blum <josh@joshknows.com>2010-04-19 18:37:05 -0700
commit97b288f7d3ee0fc0fd596f6ba454cf07304474e0 (patch)
treecfd3f54999b88f41e1d7ec2205d0863d5bf7bd0f /host/README
parent0d365ff30324ea8684388051ac509e7df22929d0 (diff)
downloaduhd-97b288f7d3ee0fc0fd596f6ba454cf07304474e0.tar.gz
uhd-97b288f7d3ee0fc0fd596f6ba454cf07304474e0.tar.bz2
uhd-97b288f7d3ee0fc0fd596f6ba454cf07304474e0.zip
documentation notes in readme
Diffstat (limited to 'host/README')
-rw-r--r--host/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/host/README b/host/README
index 558cf0e4a..05a53b197 100644
--- a/host/README
+++ b/host/README
@@ -16,3 +16,13 @@ Basic TX
LF RX
LF TX
RFX Series
+
+########################################################################
+# Documentation
+########################################################################
+Online documentation available at:
+http://ettus-apps.sourcerepo.com/redmine/ettus/projects/uhd/wiki/
+
+The build system can generate the html for the manual and Doxygen.
+Docutils and Doxygen are required to build the html docs.
+See the docs directory for the manual source (reStructuredText).