README

   1 This is the README file for OpenChange
   2
   3 ABOUT OPENCHANGE
   4
   5 The OpenChange Project aims to provide a portable Open Source
   6 implementation of Microsoft Exchange Server and Exchange
   7 protocols. Exchange is a groupware server designed to work with
   8 Microsoft Outlook, and providing features such as a messaging server,
   9 shared calendars, contact databases, public folders, notes and tasks.
  10
  11
  12 The OpenChange project has three goals:
  13 * To provide a library for interoperability with Exchange protocols, and
  14 to assist implementors to use this to create groupware that
  15 interoperates with both Exchange and other OpenChange-based software.
  16
  17 * To provide an alternative to Microsoft Exchange Server which uses
  18 native Exchange protocols and provides exactly equivalent
  19 functionality when viewed from Microsoft Outlook clients.
  20
  21 * To develop a body of knowledge about the most popular groupware
  22 protocols in use commercially today in order to promote development of
  23 a documented and unencumbered standard, with all the benefits that
  24 standards bring.
  25
  26
  27 DOCUMENTATION
  28
  29 There are two sources of documentation - text files in the doc/
  30 directory, and API documentation generated from the source files using
  31 doxygen. You can create the API documentation yourself (using "make
  32 doxygen" at the top level) or you can refer to the copy on the
  33 OpenChange web site at
  34 http://apidocs.openchange.org/overview/index.html
  35
  36
  37 [TODO: add pointers to key files within doc/ directory]
  38
  39 [TODO: add description of each directory]