Merge lp:~gtg-contributors/gtg/bug591747 into lp:~gtg/gtg/old-trunk

[Izidor Matušov]

I put a list of dependencies for every plugin and synchronization in README. When a package maintainer package GTG 0.3, she can follow the list of dependencies and create a special package for plugins/synchronization services.

[Lionel Dricot (ploum-deactivatedaccount)]

review: Approve

=== modified file 'README'
--- README	2012-08-16 19:41:55 +0000
+++ README	2012-11-02 09:10:28 +0000
@@ -17,11 +17,9 @@
  * python-support
  * python-configobj
  * python-xdg
+ * python-dbus
  * python-liblarch 
- * python-dbus
  * yelp (to read GTG documentation)
- * python-suds (dependency of MantisBT backend)
- * python-evolution (dependency of Evolution backend)
 
 To generate the API documentation, you'll also need to install 'pydoctor'.
 
@@ -31,16 +29,77 @@
 To install the all the required packages providing the basic features on
 Debian-based systems, execute the following command:
     $ sudo apt-get install python-support python-gtk2 python-gnome2 \
-         python-glade2 python-xdg python-configobj python-liblarch yelp
+         python-glade2 python-xdg python-configobj python-dbus \
+         python-liblarch yelp
 
 To enable API documentation generation, execute this command:
     $ sudo apt-get install python-pydoctor
 
-For evolution backend, you need python-evolution by command:
-    $ sudo apt-get install python-evolution
-
-For MantisBT backend, you need python-suds by command:
-    $ sudo apt-get install python-suds
+There are additional plugins (modules for extending the user interface) and
+synchronization services (modules for importing/exporting tasks from/to
+external services) which needs additional packages to work correctly.
+
+=== Dependencies for Plugins ===
+
+"Bugzilla" plugin dependencies:
+  * python-bugz
+
+"Export and print" plugin dependencies:
+  * python-cheetah
+  * pdflatex
+  * pdftk
+  * pdfjam
+
+Installable on Debian-based system via
+    $ sudo apt-get install python-cheetah pdftk pdfjam texlive-latex-base
+
+"Geolocalized tasks" plugin is not maintained for a long time and needs to be
+rewritten from scratch. Dependencies:
+  * python-geoclue
+  * python-clutter
+  * python-clutter-gtk
+  * python-champlain
+  * python-champlain-gtk
+
+"Hamster Time Tracker Integration" plugin needs a running instance of Hamster.
+
+"Notification area" plugin has only an optional dependence for systems
+which supports indicators:
+  * python-appindicator
+
+"Send task via email" plugin does not have any external dependencies.
+
+"Closed tasks remover" plugin does not have any external dependencies.
+
+"Tomboy/Gnote" plugin needs a running instance of Tomboy or Gnote.
+python-dbus
+
+"Urgency Color" plugin does not have any external dependencies.
+
+=== Dependencies for Synchronization Services ===
+
+Evolution synchronization service has dependencies:
+  * python-evolution
+  * python-dateutil
+
+Because of a bug in PyGTK (see https://bugs.launchpad.net/gtg/+bug/936183),
+the synchronization service freezes GTG and the synchronization service can't be used.
+
+MantisBT synchronization service has a dependency:
+  * python-suds
+
+Launchpad synchronization service has a dependency:
+  * python-launchpadlib
+
+Gnote and Tomboy synchronization services has no external dependency.
+
+Identica and Twitter synchronization services are shipped with the local
+version of Tweety library.
+
+Remember the Milk synchronization service is shipped with a library for RTM api. It has an external dependency:
+  * python-dateutil
+
+Remember the Milk is not maintained for a long time and might be potentially harmful.
 
 ===== Installing and Running =====
 
@@ -64,11 +123,6 @@
     $ sudo python setup.py install # must be root to install system-wide
     $ gtg
 
-Please note you have to pass --install-layout=deb option to setup.py script
-to correctly install GTG on recent Ubuntu versions (9.04 "Jaunty" or later):
-
-    $ sudo python setup.py install --install-layout=deb
-
 ==== How To Use GTG? ====
 
 Please refer to our documentation to get a thorough explanation on how GTG