summaryrefslogtreecommitdiffstats
path: root/src/libavoid/README
diff options
context:
space:
mode:
authormjwybrow <mjwybrow@users.sourceforge.net>2007-08-09 04:10:02 +0000
committermjwybrow <mjwybrow@users.sourceforge.net>2007-08-09 04:10:02 +0000
commitc0f3faf0dfcb0f4cdb257324b118fa5a121773b3 (patch)
treea11d4b4197e094a41458aec891a5bbc006181927 /src/libavoid/README
parentcopyedit, warning suppression (diff)
downloadinkscape-c0f3faf0dfcb0f4cdb257324b118fa5a121773b3.tar.gz
inkscape-c0f3faf0dfcb0f4cdb257324b118fa5a121773b3.zip
2006-08-09 Michael Wybrow <mjwybrow@users.sourceforge.net>
* src/libavoid/shape.cpp, src/libavoid/router.cpp, src/libavoid/README, src/libavoid/router.h, src/libavoid/geometry.cpp: Some minor upstream changes to the libavoid library. It now matches Inkscape and uses the correct winding direction. * src/conn-avoid-ref.cpp: Remove a 'TODO' and hack adjusting winding directions before passing object convex hulls to libavoid. (bzr r3431)
Diffstat (limited to 'src/libavoid/README')
-rw-r--r--src/libavoid/README29
1 files changed, 25 insertions, 4 deletions
diff --git a/src/libavoid/README b/src/libavoid/README
index ada0e9908..d18de589f 100644
--- 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.