Import doxygen generated api doc
[qanava.git] / readme.txt
blob22216c3ff1cbd00fc6c06975a3a4249e6bccbde2
1 Qanava v0.0.11
2 Copyright (C) 2005-2006 Benoit AUTHEMAN
3 benoit@libqanava.org
5 LICENCE:
7 Qanava is distributed under the GNU LESSER GENERAL PUBLIC LICENSE (GNU LGPL v2.1)
8 Licence is detailed in the LICENCE.txt file.
11 BUILD:
13 For Windows 2000/XP: Open the build/vc71/qanava.sln Visual Studio 2001 (or later) solution file, then build the solution. MSVC 2005 is not officially supported, you will have to re-generate all projects files by running qmake in 'pro' and 'tests' subdirectories. You eventually will have to generate all projects files in 'build/pro' using 'qmake' command.
15 For Linux, just generate makefiles with the 'qmake -recursive' command, and launch the build with 'make'. The compilation has been tested successfully with GCC 4.0.1 and QT 4.2.0 or later.
17 There are no dependencies outside of Trolltech QT.
19 Qanava is primarily developed on Windows 2000 with QT 4.2.0.
22 INSTALLATION:
24 There is currently no automated installation system, just use the 'qmake' command to generate makefiles, and gmake to build both the library and samples.
27 USING QANAVA / BUGS / PROBLEMS / etc.
29 For any problem related to Qanava, mail 'benoit@libqanava.org' or post a comment on:
30 http://www.libqanava.org/
32 If you did test Qanava, please send some feedback (even short!) by mail or via a comment.
34 I would also be interested in supporting the use of Qanava in an open source project, eventually adding specific features and dealing with problems that might occurs.
37 RELEASE NOTES:
39 v0.0.10: (06/09/29) Qanava is now using QT 4.2.0 and the new GraphicsView framework. Custom nodes attributes can now be added to nodes trough the graph interface. A library was created as a repository for widgets used to display graph features, such as styles or nodes list. An abstract factory system now allows the registration of custom nodes to be displayed in the graph view. New samples were added to demonstrate styles modifications, and how to display custom nodes attributes (9/11 social graph).
41 v0.0.8b: (06/06/09) Serious bugs in GraphItemView and GraphItemModel were fixed. Better support for GCC compilation. Qanava now work with the latest KDE4 qt-copy (qt 4.1.3).
43 v0.0.8: (16/05/02) Qanava now support a full set of features (insertion/suppression/edition) to modify its graph, and all modification are reflected to and from to Interview model. Qanava is now distributed under the GNU LGPL.
45 v0.0.7: (06/04/02) Qanava no longer depend on QCanvas and does all its drawing as a standalone widget using Arthur. Model/view system now supports on the fly node insertion and suppression. Grid architecture has been cleaned, and the usual regular grid can now be changed with a check board one. The rendering code has received numerous optimisations and the UI is now much more reactive than with QCanvas code. This is the first version that is stable enough version to be considered useable as a library in "unstable" code.
47 v0.0.6: (06/03/11) Qanava now use QtCanvas (the qt4 port of Q3Canvas), and no longer require the qt3support library (do not forget to copy qtcanvas.cpp and qtcanvas.h from your QT installation to the src/can directory).
49 v0.0.5: (06/01/09) Qanava has the same canvas problems than in v0.0.4. Q3Canvas in Qt 4.1 is better than in Qt 4.0.1, but still far from being as fast and bug free than in Qt 3. This serious canvas problem cannot be addressed until Trolltech release their new canvas system in Qt 4.2.0.
51 v0.0.4: (05/11/29) While Qanava is now a qt4 library, the old QCanvas class is still used for graphic rendering until the new qt4 canvas system is released with qt4.1 (even if there is no such system be in the preview release, hum...). The support for the old canvas in qt 4.0.1 is extremely slow, and seems to be seriously buggy (clipping and zoom problems). The X11 version of Q3Canvas seems to be less affected than win32, anyways, Qanava v0.0.4 should be considered a transition release until the display 'backend' is stabilized (either using Arthur, or hopefully a new graphic canvas).
54 NO WARRANTY
56   BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
57 WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
58 EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
59 OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
60 KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
61 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
62 PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
63 LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
64 THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.