Commit [r1168] Maximize Restore History

cleanup top-level doc files

awinterz 2014-04-06

added /trunk/libical/ReadMe.md
added /trunk/libical/ReleaseNotes.txt
removed /trunk/libical/INSTALL
removed /trunk/libical/README.win32
copied /trunk/libical/README -> /trunk/libical/ReadMe.txt
copied /trunk/libical/README.cmake -> /trunk/libical/Install.txt
/trunk/libical/ReadMe.md Diff Switch to side-by-side view
Loading...
/trunk/libical/ReleaseNotes.txt Diff Switch to side-by-side view
Loading...
/trunk/libical/INSTALL
File was removed.
/trunk/libical/README.win32
File was removed.
/trunk/libical/README to /trunk/libical/ReadMe.txt
--- a/trunk/libical/README
+++ b/trunk/libical/ReadMe.txt
@@ -1,19 +1,37 @@
-
+Introduction
+============
 LIBICAL -- an implementation of iCalendar protocols and data formats
 
 Most of the code in here was written by Eric Busboom with help from
 dozens of contributors.  It is currently maintained by Art Cancro
 and Wilfried Goesgens.
 
-libical is available for you to use under your choice of the Mozilla
-Public License (MPL) v1.0 or the GNU Library General Public License
-(LGPL) v2.1.
+Libical is an Open Source implementation of the iCalendar protocols
+and protocol data units. The iCalendar specification describes how
+calendar clients can communicate with calendar servers so users can
+store their calendar data and arrange meetings with other users. 
+
+Libical implements RFC2445, RFC2446 and some of RFC2447.
+
+
+License
+========
+The code and datafiles in this distribution are licensed under the
+Mozilla Public License (MPL) v1.0. See http://www.mozilla.org/MPL/1.0
+for a copy of the license. 
+
+Alternately, you may use libical under the terms of the GNU Library
+General Public License (LGPL) v2.1. See http://www.gnu.org/licenses/lgpl-2.1.txt
+for a copy of the license.
 
 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.  We will only accept
-changes into the library if they are similarly dual-licensed.
+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.
 
+
+Acknowledgments
+===============
 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
@@ -23,83 +41,21 @@
 Raadt.  See the header for src/libical/vsnprintf.c for the full
 copyright statement.
 
-If you would like to contribute to this project, please visit the
-SourceForge page: http://freeassociation.sourceforge.net
+
+Get Involved
+============
+If you would like to contribute, monitor or report bug fixes to the project,
+visit http://sourceforge.net/projects/freeassociation/
+
+Subscribe to our development mailing list at https://lists.sourceforge.net/lists/listinfo/freeassociation-devel
 
 
 Building the library
---------------------
-
-This distribution is developed on CentOS Linux and should also
-build cleanly on any unix-like system as long as it has the usual
-set of open source build tools online.
-
-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 SVN, there will be no configure file until
-you create one with the "bootstrap" script.
-
-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 SVN, 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 SVN. 
-
-When updating to a new release, tweak the version number in the following files:
-CMakeLists.txt
-configure.in
-src/libical/icalversion.h
-src/java/Makefile.am
-src/libicalcap/Makefile.am
-src/libical/Makefile.am
-src/libicalss/Makefile.am
-src/libicalvcal/Makefile.am
-src/java/CMakeLists.txt
-src/libicalcap/CMakeLists.txt
-src/libicalss/CMakeLists.txt
-src/libicalvcal/CMakeLists.txt
+====================
+See the top-level Install.txt file.
 
 
 Using the Library
------------------
-
+=================
 There is rudimentary, unfinished documentation in the /doc directory,
 and annotated examples in /examples and the test code in src/test.
-
-Sourcecode now in SVN
----------------------
-We now work in our SF.net SVN Repository. Please don't use the CVS anymore.
/trunk/libical/README.cmake to /trunk/libical/Install.txt
--- a/trunk/libical/README.cmake
+++ b/trunk/libical/Install.txt
@@ -1,16 +1,22 @@
-libical supports the CMake buildsystem.
-You must have CMake version 2.4 or higher.
+Cubical v1.0 and above uses the CMake buildsystem.
+The autoconf build system has been removed and is no longer supported.
 
 Please see the comments at the top of CMakeLists.txt for
 the available configuration options you can pass to cmake.
 
 The installation directory defaults to /usr/local on UNIX
-and c:/Program Files on Windows. You can change this by
+and c:/Program Files on Windows.  You can change this by
 passing -DCMAKE_INSTALL_PREFIX=/install/path to cmake.
 
 To build a debug version pass -DCMAKE_BUILD_TYPE=Debug to cmake.
 
-Building on Linux/Unix with a native compiler:
+To build libical you will need:
+ - CMake version 2.4 or higher
+ - Perl
+ - libicu (not required but strongly recommended)
+ - a C compiler (let us know if the build fails with your C compiler)
+
+Building on Unix with gcc or clang:
 % mkdir build
 % cd build
 % cmake ..
@@ -24,14 +30,12 @@
 % nmake
 % nmake install
 
-
 Building on Windows with mingw:
 % mkdir build
 % cd build
 % cmake -G "MinGW Makefiles" ..
 % mingw32-make
 % mingw32-make install
-
 
 Building on Windows under Cygwin:
 % mkdir build