213.1.3
by Bertrand Rousseau
Add wiki url in README + s/Gnome/GNOME/ |
1 |
====== Getting Things GNOME! ====== |
169.2.1
by Lionel Dricot
README file |
2 |
|
1229.2.2
by Bertrand Rousseau
Typo in GTG description |
3 |
Getting Things GNOME! (GTG) is a personal tasks and TODO list items organizer |
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
4 |
for the GNOME desktop environment inspired by the Getting Things Done (GTD) |
5 |
methodology. GTG is designed with flexibility, adaptability, and ease of use |
|
6 |
in mind so it can be used as more than just GTD software. |
|
169.2.1
by Lionel Dricot
README file |
7 |
|
562.5.1
by Bryce Harrington
fix spacing typo |
8 |
GTG is intended to help you track everything you need to do and need to know, |
196
by Lionel Dricot
changelog |
9 |
from small tasks to large projects. |
169.2.1
by Lionel Dricot
README file |
10 |
|
11 |
===== Dependencies ===== |
|
12 |
||
196
by Lionel Dricot
changelog |
13 |
GTG depends on the following packages: |
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
14 |
|
817
by Luca Falavigna
python2.6 is default almost everywhere, drop compatibility functions |
15 |
* Python, version 2.6 or above |
196
by Lionel Dricot
changelog |
16 |
* PyGTK |
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
17 |
* python-support |
1116
by Izidor Matušov
Updated README with the current dependencies |
18 |
* python-xdg |
1238.2.1
by Izidor Matušov
Updated README file with list of dependencies for each plugin/service + removed the note about --install-layout which is no longer accurate |
19 |
* python-dbus |
1116
by Izidor Matušov
Updated README with the current dependencies |
20 |
* python-liblarch |
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
21 |
* yelp (to read GTG documentation) |
278.1.3
by Jonathan Lange
Mention the pydoctor dependency. |
22 |
|
278.1.1
by Jonathan Lange
Whitespace cleanup |
23 |
Please refer to your system documentation for information on how to install |
196
by Lionel Dricot
changelog |
24 |
these modules if they're not currently available. |
169.2.1
by Lionel Dricot
README file |
25 |
|
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
26 |
To install the all the required packages providing the basic features on
|
27 |
Debian-based systems, execute the following command:
|
|
28 |
$ sudo apt-get install python-support python-gtk2 python-gnome2 \
|
|
1306.1.15
by huxuan
Remove configobj related description in README |
29 |
python-glade2 python-xdg python-dbus python-liblarch yelp
|
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
30 |
|
1238.2.1
by Izidor Matušov
Updated README file with list of dependencies for each plugin/service + removed the note about --install-layout which is no longer accurate |
31 |
There are additional plugins (modules for extending the user interface) and
|
32 |
synchronization services (modules for importing/exporting tasks from/to
|
|
33 |
external services) which needs additional packages to work correctly.
|
|
34 |
||
35 |
=== Dependencies for Plugins ===
|
|
36 |
||
37 |
"Bugzilla" plugin dependencies:
|
|
38 |
* python-bugz
|
|
39 |
||
40 |
"Export and print" plugin dependencies:
|
|
41 |
* python-cheetah
|
|
42 |
* pdflatex
|
|
43 |
* pdftk
|
|
44 |
* pdfjam
|
|
45 |
||
46 |
Installable on Debian-based system via
|
|
47 |
$ sudo apt-get install python-cheetah pdftk pdfjam texlive-latex-base
|
|
48 |
||
49 |
"Geolocalized tasks" plugin is not maintained for a long time and needs to be
|
|
50 |
rewritten from scratch. Dependencies:
|
|
51 |
* python-geoclue
|
|
52 |
* python-clutter
|
|
53 |
* python-clutter-gtk
|
|
54 |
* python-champlain
|
|
55 |
* python-champlain-gtk
|
|
56 |
||
57 |
"Hamster Time Tracker Integration" plugin needs a running instance of Hamster.
|
|
58 |
||
59 |
"Notification area" plugin has only an optional dependence for systems
|
|
60 |
which supports indicators:
|
|
61 |
* python-appindicator
|
|
62 |
||
63 |
"Send task via email" plugin does not have any external dependencies.
|
|
64 |
||
65 |
"Closed tasks remover" plugin does not have any external dependencies.
|
|
66 |
||
67 |
"Tomboy/Gnote" plugin needs a running instance of Tomboy or Gnote.
|
|
68 |
python-dbus
|
|
69 |
||
70 |
"Urgency Color" plugin does not have any external dependencies.
|
|
71 |
||
72 |
=== Dependencies for Synchronization Services ===
|
|
73 |
||
74 |
Evolution synchronization service has dependencies:
|
|
75 |
* python-evolution
|
|
76 |
* python-dateutil
|
|
77 |
||
78 |
Because of a bug in PyGTK (see https://bugs.launchpad.net/gtg/+bug/936183),
|
|
79 |
the synchronization service freezes GTG and the synchronization service can't be used. |
|
80 |
||
81 |
MantisBT synchronization service has a dependency: |
|
82 |
* python-suds |
|
83 |
||
84 |
Launchpad synchronization service has a dependency: |
|
85 |
* python-launchpadlib |
|
86 |
||
87 |
Gnote and Tomboy synchronization services has no external dependency. |
|
88 |
||
89 |
Identica and Twitter synchronization services are shipped with the local |
|
90 |
version of Tweety library. |
|
91 |
||
92 |
Remember the Milk synchronization service is shipped with a library for RTM api. It has an external dependency: |
|
93 |
* python-dateutil |
|
94 |
||
95 |
Remember the Milk is not maintained for a long time and might be potentially harmful. |
|
1185.1.1
by huxuan
Revise in README for python-suds and python-evolution installation |
96 |
|
169.2.1
by Lionel Dricot
README file |
97 |
===== Installing and Running ===== |
98 |
||
196
by Lionel Dricot
changelog |
99 |
To install GTG, either unpack the tarball: |
278.1.1
by Jonathan Lange
Whitespace cleanup |
100 |
|
196
by Lionel Dricot
changelog |
101 |
$ tar xzvf gtg.tar.gz |
169.2.1
by Lionel Dricot
README file |
102 |
|
278.1.1
by Jonathan Lange
Whitespace cleanup |
103 |
or check out our bazaar branch for a development version (we try to keep those |
196
by Lionel Dricot
changelog |
104 |
unbroken and ready for production use): |
278.1.1
by Jonathan Lange
Whitespace cleanup |
105 |
|
169.2.1
by Lionel Dricot
README file |
106 |
$ bzr branch lp:gtg |
107 |
||
196
by Lionel Dricot
changelog |
108 |
To run GTG, either execute it directly from the source folder: |
169.2.1
by Lionel Dricot
README file |
109 |
|
110 |
$ cd gtg/ |
|
111 |
$ ./gtg |
|
112 |
||
196
by Lionel Dricot
changelog |
113 |
or install it system-wide (must install as root to install system-wide): |
169.2.1
by Lionel Dricot
README file |
114 |
|
115 |
$ cd gtg |
|
196
by Lionel Dricot
changelog |
116 |
$ sudo python setup.py install # must be root to install system-wide |
169.2.1
by Lionel Dricot
README file |
117 |
$ gtg |
118 |
||
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
119 |
==== How To Use GTG? ==== |
120 |
||
121 |
Please refer to our documentation to get a thorough explanation on how GTG |
|
122 |
works. |
|
123 |
||
124 |
To do this, you will need the yelp help viewer. On Debian-based systems, you |
|
125 |
can install yelp by executing this command: |
|
126 |
||
127 |
$ sudo apt-get install yelp |
|
128 |
||
129 |
You can then view the documentation either by accessing it through GTG (press |
|
130 |
F1 or use the help menu), or by using the command line using the following |
|
131 |
command: |
|
132 |
||
133 |
$ yelp help:gtg |
|
134 |
||
135 |
If you want to read the documentation directly from the source code, use |
|
136 |
this command (from the source root dir): |
|
137 |
||
138 |
$ yelp doc/userdoc/C/index.page |
|
139 |
||
140 |
==== Using GTG from the command line ==== |
|
141 |
||
142 |
GTG provides two command line tools that allows to interact with GTG: |
|
143 |
||
144 |
* gtcli |
|
145 |
* gtg_new_task |
|
146 |
||
147 |
gtcli provides many options to display, list or edit tasks. gtg_new_task |
|
148 |
provides a GTG command line client that allows to easily add tasks. |
|
149 |
||
150 |
If you want to know more about how to use these tools, please refer to the |
|
151 |
tools man page. |
|
152 |
||
153 |
If you have installed gtg, you can access those by executing: |
|
154 |
||
155 |
$ man gtcli |
|
156 |
$ man gtg_new_task |
|
169.2.1
by Lionel Dricot
README file |
157 |
|
158 |
===== Want to know more? ===== |
|
159 |
||
196
by Lionel Dricot
changelog |
160 |
* GTG Website: http://gtg.fritalk.com/ |
161 |
* GTG project page on Launchpad: https://launchpad.net/gtg |
|
213.1.3
by Bertrand Rousseau
Add wiki url in README + s/Gnome/GNOME/ |
162 |
* GTG Wiki: http://live.gnome.org/gtg/ |
1229.2.1
by Bertrand Rousseau
Update README file (and HACKING too, while I'm at it), fixing bugs #897440 and #940833 |
163 |
|
164 |
Feel free to join our user mailing-list to receive news about GTG. You can |
|
165 |
register on this mailing-list from this page: https://launchpad.net/~gtg-user |
|
166 |
||
167 |
Thanks for using GTG! |