summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Gielda <mgielda@antmicro.com>2014-04-08 22:44:06 +0200
committerMichael Gielda <mgielda@antmicro.com>2014-04-08 22:44:06 +0200
commita2afe186ed82871c928e09e18085c05a5fb49c83 (patch)
treeb059d9992b959c559baf0e03551c70c34c9043a6
parentcca3d392687c4c98d7989db8b7a389ab4ce3c029 (diff)
First try at #5
-rw-r--r--README.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 1ff7170..5027403 100644
--- a/README.rst
+++ b/README.rst
@@ -34,3 +34,12 @@ This eCos port provides the following software packages specific for Toradex Col
* serial port driver
* Flex Timer Module
* GPIO handling
+
+Documentation
+-------------
+
+The documentation for this port, residing in the ``doc`` directory, is written in ReStructuredText and is meant to be generated to HTML or PDF via Sphinx.
+
+It is however possible to use GitHub ``.rst`` file rendering as a fallback:
+
+* `introduction <blob/master/doc/source/introduction.rst>`_