diff README.txt @ 79:0ccf3fd49181

Add license and some documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 13 Jul 2016 12:59:50 +0300
parents 8ef792b573a9
children 286ccecf9257
line wrap: on
line diff
--- a/README.txt	Wed Jul 13 12:59:33 2016 +0300
+++ b/README.txt	Wed Jul 13 12:59:50 2016 +0300
@@ -1,8 +1,31 @@
-Google Calendar MultiMerge(tm) 9000
-===================================
-By Matti 'ccr' Hämäläinen <ccr@tnsp.org>
+Google Calendar MultiMerge
+==========================
+Programmed and designed by Matti 'ccr' Hämäläinen <ccr@tnsp.org>
+(C) Copyright 2016 Tecnic Software productions (TNSP)
+
+For license information, see file "COPYING".
+
+Introduction
+============
+
+Google Calendar Multimerge (GCMM) is a simple Python utility for
+creating a "merged" calendar from a number of "source" calendars.
+Through Google Calendar API, events are copied from source calendars
+to the target calendar and updated on each run. Deleted events will
+be accordingly deleted from the target.
+
+In practice, the target is always an amalgamate of the sources, if
+any events are added or deleted from it manually, they will be deleted
+or re-added accordingly from it on the next run of GCMM.
+
+The reason for GCMM is that while an amalgamate view of all calendars
+(shared or not) can be viewed through the main calendar site, the
+amalgamate view can't be shared or viewed as an embedded element
+directly.
 
 
+How to use
+==========
 
 First, we need to install the required Python tools in order to
 install the required Google API Python modules ... in Debian/Ubuntu,