summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-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>`_