changeset 91:ae3f20933758

Update documentation a bit.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 27 Jul 2016 13:09:18 +0300
parents 286ccecf9257
children a348dfa6b132
files README.txt
diffstat 1 files changed, 14 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Tue Jul 26 17:02:42 2016 +0300
+++ b/README.txt	Wed Jul 27 13:09:18 2016 +0300
@@ -27,21 +27,23 @@
 directly.
 
 
-How to use
-==========
+Installation
+============
 
 First, we need to install the required Python tools in order to
-install the required Google API Python modules ... in Debian/Ubuntu,
+install the required Google API Python modules ... in Debian,
 chant the following magic incantations:
 
 $ sudo apt-get install python-pip python-setuptools python-wheel
 
+In Ubuntu and other distributions package names may be different.
+
+
 Then, use PIP to install Google API stuff locally for the user ..
 
 $ pip install --upgrade google-api-python-client
 
---
-
+If the installation passes without errors, you are good to go.
 At this point, you will need to enable the Calendar API from
 Google's control panel. Refer to the following web page:
 
@@ -50,11 +52,14 @@
 The section "Step 1" has the instructions. We've already done "Step 2",
 which is incomplete in the guide anyway.
 
---
+
+Configuration and usage
+=======================
 
-Finally, edit example.cfg and run multimerge with config file as
-command line parameter (if no configuration file is specified,
-certain default settings will be used):
+Edit example.cfg and run multimerge with config file as command line
+parameter. At the very least, you will need to define the "dest_name"
+and "dest_regex" settings in the configuration. The settings are
+described in the example configuration file.
 
 $ ./multimerge.py example.cfg