README

   1
   2 LIBICAL -- an implementation of iCalendar protocols and data formats
   3
   4 Most of the code in here was written by Eric Busboom with help from
   5 dozens of contributors.  It is currently maintained by Art Cancro
   6 and Wilfried Goesgens.
   7
   8 libical is available for you to use under your choice of the Mozilla
   9 Public License (MPL) v1.0 or the GNU Library General Public License
  10 (LGPL) v2.1.
  11
  12 This dual license ensures that the library can be incorporated into
  13 both proprietary code and GPL'd programs, and will benefit from
  14 improvements made by programmers in both realms.  We will only accept
  15 changes into the library if they are similarly dual-licensed.
  16
  17 Portions of this distribution are (C) Copyright 1996 Apple Computer,
  18 Inc., AT&T Corp., International Business Machines Corporation and
  19 Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for
  20 details.
  21
  22 Portions of this distribution are Copyright (c) 1997 Theo de
  23 Raadt.  See the header for src/libical/vsnprintf.c for the full
  24 copyright statement.
  25
  26 If you would like to contribute to this project, please visit the
  27 SourceForge page: http://freeassociation.sourceforge.net
  28
  29
  30 Building the library
  31 --------------------
  32
  33 This distribution is developed on CentOS Linux and should also
  34 build cleanly on any unix-like system as long as it has the usual
  35 set of open source build tools online.
  36
  37 The library is configured with automake. IF YOU ARE BUILDING THE
  38 SOURCE FROM A TARBALL, From the root directory, run
  39
  40         ./configure
  41
  42 To build all of the Makefiles for your system. If you will be
  43 installing the library, you may want to use the --prefix flag to set
  44 the directory where the library and header files will be installed.
  45
  46         ./configure --prefix=/proj/local/
  47
  48 If configure runs fine, run "make" to build the library and
  49 "make install" to install it.
  50
  51 Although the distribution uses libtool to generate libraries, it has
  52 shared libraries turned off by default. To create and install shared
  53 libraries use:
  54
  55         ./configure --enable-shared
  56
  57
  58 IF YOU ARE BUILDING FROM SVN, there will be no configure file until
  59 you create one with the "bootstrap" script.
  60
  61 The current version of libical focuses on creating and
  62 manipulating iCal objects. With it, you can parse text representations
  63 of iCal components, add and remove sub-components, properties,
  64 parameters and values, and print the components back out as strings.
  65
  66
  67 Notes for Libical Developers
  68 ----------------------------
  69
  70 If you don't want to use gcc as the compiler, and you got the sources
  71 from SVN, you should set the CC variable to the path to the compiler
  72 and run "automake --include-deps" to keep automake from using
  73 gcc-specific automatic dependancy tracking.
  74
  75         > CC=/pkg/SUNWspro/bin/cc; export CC
  76         > automake --include-deps
  77         > ./configure --prefix=/proj/local/
  78         > make
  79
  80 You will not need to re-run automake unless you got the sources from SVN.
  81
  82 When updating to a new release, tweak the version number in the following files:
  83 CMakeLists.txt
  84 configure.in
  85 src/libical/icalversion.h
  86 src/java/Makefile.am
  87 src/libicalcap/Makefile.am
  88 src/libical/Makefile.am
  89 src/libicalss/Makefile.am
  90 src/libicalvcal/Makefile.am
  91 src/java/CMakeLists.txt
  92 src/libicalcap/CMakeLists.txt
  93 src/libicalss/CMakeLists.txt
  94 src/libicalvcal/CMakeLists.txt
  95
  96
  97 Using the Library
  98 -----------------
  99
 100 There is rudimentary, unfinished documentation in the /doc directory,
 101 and annotated examples in /examples and the test code in src/test.
 102
 103 Sourcecode now in SVN
 104 ---------------------
 105 We now work in our SF.net SVN Repository. Please don't use the CVS anymore.