[icalendar-checkins] r11573 - iCalendar/trunk

[faassen at codespeak.net]

Author: faassen
Date: Thu Apr 28 14:59:10 2005
New Revision: 11573

Modified:
   iCalendar/trunk/README.txt
Log:
More editing preparing for release.


Modified: iCalendar/trunk/README.txt
==============================================================================
--- iCalendar/trunk/README.txt	(original)
+++ iCalendar/trunk/README.txt	Thu Apr 28 14:59:10 2005
@@ -8,27 +8,29 @@
 
 http://www.ietf.org/rfc/rfc2445.txt
 
-Summary
-=======
+Introduction
+============
     
-I have often needed to parse and generate iCalendar files. Finally I
-got tired of writing ad-hoc tools.
+I (Max M) have often needed to parse and generate iCalendar
+files. Finally I got tired of writing ad-hoc tools.
     
 So this is my attempt at making an iCalendar package for Python. The
 inspiration has come from the email package in the standard lib, which
-I think is pretty simple, yet efficient and powerfull.
+I think is pretty simple, yet efficient and powerful.
 
 The aim is to make a package that is fully compliant to RFC 2445, well
 designed, simple to use and well documented.
 
-Look in doc/example.py for introductory doctests and explanations.
+Look in doc/example.txt for introductory doctests and explanations.
     
-All modules and classes have doctest that shows how they work, so it
-is all pretty well documented.
+All modules and classes have doctests that shows how they work, so it
+is all pretty well documented. There is also an interfaces.py file
+which describe the API in src/icalendar.
     
-It can generate and parse iCalender files, and can easily be used as is.
+It can generate and parse iCalender files, and can easily be used as
+is.
     
-But it does needs a bit more polish before i will considder it
+But it does need a bit more polish before i will considder it
 finished. I would say that it's about 95% done.
     
 Examples
@@ -47,7 +49,7 @@
   'VEVENT'
   'VEVENT'
         
-To create a calendar and write it to disc::
+To create a calendar and write it to disk::
         
   >>> cal = Calendar()
   >>> from datetime import datetime
@@ -72,15 +74,22 @@
 Dependencies
 ============
     
-It is dependent on the datetime package, so it requires Python >= 2.3
+It is dependent on the datetime package, so it requires Python >=
+2.3. There are no other dependencies.
 
-Feedback/contact
-================
+Mailing list
+============
 
-If you have any comments or feedback on the module, please contact me
-at maxm at mxm.dk
-    
-I would love to hear use cases, or get ideas for improvements.
+If you have any comments or feedback on the module, please use the iCalendar
+mailing list. You can subscribe to it here:
+   
+http://codespeak.net/mailman/listinfo/icalendar-dev
+
+We would love to hear use cases, or get ideas for improvements.
+
+There is also a checkins mailing list, if you want to follow development:
+
+http://codespeak.net/mailman/listinfo/icalendar-checkins
 
 Download
 ========