Tablet auto-organization and naming.

[inkscape.git] / src / libavoid / README

diff --git a/src/libavoid/README b/src/libavoid/README
index ada0e9908fec6a7d8c222fe8061faa85d7dc7a84..d18de589f60b3d829ad871830770c177a9e137fe 100644 (file)
--- a/src/libavoid/README
+++ b/src/libavoid/README
@@ -1,5 +1,26 @@
-This directory contains libavoid-0.1.  It has been included here since it is
-a new library without wide availablity.
+libavoid - Fast, Incremental, Object-avoiding Line Router
+Copyright (C) 2004-2007  Michael Wybrow <mjwybrow@users.sourceforge.net>
+
+A cross-platform C++ library providing fast, object-avoiding connector
+routing for use in interactive diagram editors.
+
+
+This is an alpha release.  There is currently no documentation due to the
+fact that orthogonal connectors are being worked on as well as other features
+such as connector crossing avoidance.  Once these features are present, 
+documentation will be added for the interface.  At the same time, the build
+system will be cleaned up to use the configure/automake tools, and the first
+"offical" release of libavoid will be made.
+
+libavoid is currently used in the prototype research diagram editor "Dunnart":
+  http://www.csse.monash.edu.au/~mwybrow/dunnart/
+As well as the professional open-source vector graphics editor "Inkscape":
+  http://www.inkscape.org/
+
+The algorithms used for the connector routing are described in:
+
+  M. Wybrow, K. Marriott, and P.J. Stuckey. Incremental connector routing.
+  In Proceedings of 13th International Symposium on Graph Drawing, LNCS 3843,
+  pages 446-457. Springer-Verlag, 2006.
+  http://www.csse.monash.edu.au/~mwybrow/papers/wybrow-gd-2005.pdf
 
-The project page is http://www.sourceforge.net/projects/libavoid/
-The library's maintainer is Michael Wybrow, an Inkscape developer.