changeset 11:fc38fc0c44ae

Added section for API docs.
author Martin Geisler <mg@daimi.au.dk>
date Thu, 14 Feb 2008 09:51:51 +0100
parents 61d436e79bdb
children c5dd64633204
files docs/index.txt
diffstat 1 files changed, 17 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/docs/index.txt	Thu Feb 14 09:48:02 2008 +0100
+++ b/docs/index.txt	Thu Feb 14 09:51:51 2008 +0100
@@ -5,15 +5,23 @@
  VIFF Documentation
 ====================
 
-Here you will find some resources about VIFF. Apart from these we
-would also like to refer to the `API documentation`_ which not only
-describes the API, but also tries to give a overview of the VIFF
-architecture. The code examples includes in the ``apps/`` directory
-also contains many hints on best practices with VIFF. Finally, the
-unit tests in the ``viff/test/`` directory will show you many small
-programs using all of VIFF.
+Here you will find some resources about VIFF.
+
+API Documentation
+~~~~~~~~~~~~~~~~~
+
+* The API documentation not only describes the API, but also tries to
+  give a overview of the VIFF architecture.
 
-.. _API documentation: http://viff.dk/api/
+  Available `online`__.
+
+  .. __: http://viff.dk/api/
+
+* The code examples includes in the ``apps/`` directory also contains
+  many hints on best practices with VIFF.
+
+* The unit tests in the ``viff/test/`` directory will show you many
+  small programs using all of VIFF.
 
 Presentations
 ~~~~~~~~~~~~~
@@ -27,6 +35,6 @@
   .. _SIMAP: http://simap.dk/
   .. __: design-talk.pdf
 
-Please `send us`__ any presentations you make.
+Please `send us`__ any presentations or programs you make.
 
 .. __: mailto:viff-devel@viff.dk