diff options
Diffstat (limited to 'libkcal/libical/README')
-rw-r--r-- | libkcal/libical/README | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/libkcal/libical/README b/libkcal/libical/README new file mode 100644 index 000000000..19a4740e9 --- /dev/null +++ b/libkcal/libical/README @@ -0,0 +1,102 @@ + +LIBICAL -- An implementation of basic iCAL protocols + +The code and datafiles in this distribution are licensed under the +Mozilla Public License. See http://www.mozilla.org/NPL/MPL-1.0.html +for a copy of the license. Alternately, you may use libical under the +terms of the GNU Library General Public License. See +http://www.fsf.org/copyleft/lesser.html for a copy of the LGPL. + +This dual license ensures that the library can be incorporated into +both proprietary code and GPL'd programs, and will benefit from +improvements made by programmers in both realms. I will only accept +changes into my version of the library if they are similarly +dual-licensed. + +Portions of this distribution are (C) Copyright 1996 Apple Computer, +Inc., AT&T Corp., International Business Machines Corporation and +Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for +details. + +Portions of this distribution are Copyright (c) 1997 Theo de +Raadt. See the header for src/libical/vsnprintf.c for the full +copyright statement. + +This code is under active development. If you would like to contribute +to the project, you can contact me, Eric Busboom, at +eric@softwarestudio.org. The project has a webpage at + + http://softwarestudio.org/libical/index.html + +and a mailing list that you can join by sending the following mail: + + ------------ + To: minimalist@softwarestudio.org + Subject: subscribe libical + ------------ + + +Building the library +-------------------- + +This distribution is developed on Red Hat Linux 6.0 and usually +compiles on SunOS 5.6 and FreeBSD 2.27. I have reports of success of +previous version on MacOS ( with CodeWarrior ) and on UnixWare, but I +don't know about any other systems. + +The library is configured with automake. IF YOU ARE BUILDING THE +SOURCE FROM A TARBALL, From the root directory, run + + ./configure + +To build all of the Makefiles for your system. If you will be +installing the library, you may want to use the --prefix flag to set +the directory where the library and header files will be installed. + + ./configure --prefix=/proj/local/ + +If configure runs fine, run "make" to build the library and +"make install" to install it. + +Although the distribution uses libtool to generate libraries, it has +shared libraries turned off by default. To create and install shared +libraries use: + + ./configure --enable-shared + + +IF YOU ARE BUILDING FROM CVS, there will be no configure file until +you create one with autogen.sh. YOu can pass configure parameters to +autogen.sh on the command line. + +The current version of libical focuses on creating and +manipulating iCal objects. With it, you can parse text representations +of iCal components, add and remove sub-components, properties, +parameters and values, and print the components back out as strings. + + +Notes for Libical Developers +------------------- + +If you don't want to use gcc as the compiler, and you got the sources +from CVS, you should set the CC variable to the path to the compiler +and run "automake --include-deps" to keep automake from using +gcc-specific automatic dependancy tracking. + + > CC=/pkg/SUNWspro/bin/cc; export CC + > automake --include-deps + > ./configure --prefix=/proj/local/ + > make + +You will not need to re-run automake unless you got the sources from CVS. + +Using the Library +----------------- + +There is rudimentary, unfinished documentation in the /doc directory, +and annotated examples in /examples and the test code in src/test. + + + +Eric Busboom +eric@softwarestudio.org |