                          README for Calligra Suite

Calligra Suite is a collection of office applications linked together by a
common base.  This common base assures that all office application can
work together and also share a common look and feel.

Calligra Suite is free software, mostly under LGPL 2+ but also under the GPL.
See COPYING and COPYING.LIB for the details.  See also copyright and
licensing notices in individual files.


Contents
--------

The applications currently included in Calligra Suite (version 2.1) are:

Office productivity:
- Words      -  Word processor
- Tables     -  Spreadsheet calculator
- Stage      -  Presentation program

Graphics:
- Karbon     -  Vector graphics 
- Krita      -  Advanced drawing and image manipulation

More information about Krita can be found at http://www.krita.org

Management:
- Plan       -  Project planning
- Kexi       -  Integrated data management

Advanced plugins:
- KChart     -  Graphic data visualization
- KFormula   -  Mathematical formulas

The applications not yet part of the official release, but will
be included in a next version:

- Flow      -  Flowcharting program

More information can be found at http://www.calligra.org


Building and running
--------------------

Calligra Suite is based on the KDE libraries ( http://www.kde.org ) which are
needed to run Calligra Suite.  Note that you don't have to actually run the
KDE desktop environment in order to use Calligra Suite.  Calligra Suite works fine
on any desktop or platform.

You will need kdesupport, kdelibs and kdebase/runtime
installed if you want to compile and run Calligra Suite. Installing kdepimlibs
gives more functionality.
For importing some external file formats or other plugins, you may
also need some other dependencies.  For more details on how to build
Calligra Suite from the sources, see

http://community.kde.org/Calligra/Building/Building_Calligra


The Calligra Suite source tree
-----------------------

Here follows a short overview of the source code.

cmake/       files to help cmake do it's job configuring
doc/         user documentation.  

karbon/      source code of the different applications
kexi/
kplato/
kpresenter/  
krita/
kspread/
words/
kivio/

kounavail    a shape that is used when an application that handles a
             certain embedded datatype is not available

libs/        the common libraries
plugins/     some plugins, both flake shapes and other types.

filters/     import and export filters for foreign file formats

tools/       tools used internally (e.g. for testing) and released
             with Calligra Suite, such as the koconverter file format 
             conversion tool.

interfaces/  simplified external interfaces to some advanced data types
             such as charts.

servicetypes/ desktop files for some service types provided by Calligra Suite

templates/   templates for new documents.
             NOTE: Out of date since they use the old Calligra Suite file formats

kdgantt/     and advanced gantt chart library provided by an external vendor.

pics/        icons


Contact info
------------

Developer and User mailing list: mailto:calligra-devel@kde.org
Kexi User mailing list:          mailto:kexi@kde.org
Krita mailing list:              mailto:kimageshop@kde.org

Subscribing and list information: http://www.kde.org/mailinglists
Archives: http://lists.kde.org

IRC channel for developers:  #calligra on irc.freenode.org
IRC channel for Kexi:        #kexi on irc.freenode.org
IRC channel for Krita:       #krita on irc.freenode.org

Calligra Suite forums:       http://forum.kde.org/viewforum.php?f=203
Krita forums:                http://forum.kde.org/viewforum.php?f=136

If you have questions about this README file or about Calligra Suite in general,
please mail to the Calligra Suite mailing list: mailto:calligra-devel@kde.org


Inge Wallin
Boudewijn Rempt
