Updated README
authorThomas Jarosch <thomas.jarosch@intra2net.com>
Fri, 29 Jun 2012 07:37:42 +0000 (09:37 +0200)
committerThomas Jarosch <thomas.jarosch@intra2net.com>
Fri, 29 Jun 2012 07:37:42 +0000 (09:37 +0200)
README

diff --git a/README b/README
index 347da3b..df800f9 100644 (file)
--- a/README
+++ b/README
@@ -22,15 +22,17 @@ Python version 3 or later
 
 Necessary files:
 - userdata.csv: Contains information necessary for the user session with format:
-               username,password
-               testuser1,testpass1
-               testuser2,testpass2
+        username,password
+        testuser1,testpass1
+        testuser2,testpass2
+
+  Note: The first line are the column names and gets ignored.
 
 Produced files:
-- confscript.cfg: Configuration of the script - created on first run.
-- message_cache.dat: Cache file used for performance improvements
-- fix_imap_internaldate.log: Log file that resets with the script.
+- fix_imap_internaldate.cfg: Configuration of the script - created on first run.
+- fix_imap_internaldate.log: Log file. Will be truncated on script invocation.
 - conflict_stats.txt: Final report on statistics about detected date conflicts and missing dates.
+- message_cache.dat: Cache file used for performance improvements
 
 Invocation on Windows requires and results in the same files.