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 |
|
278.1.1
by Jonathan Lange
Whitespace cleanup |
3 |
Getting Things GNOME! (GTG) is a personal organizer for the GNOME desktop |
4 |
environment inspired by the Getting Things Done (GTD) methodology. GTG is |
|
5 |
designed with flexibility, adaptability, and ease of use in mind so it can be |
|
6 |
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: |
817
by Luca Falavigna
python2.6 is default almost everywhere, drop compatibility functions |
14 |
* Python, version 2.6 or above |
196
by Lionel Dricot
changelog |
15 |
* PyGTK |
16 |
* python ConfigObj |
|
17 |
* python gobject |
|
18 |
* python XDG |
|
278.1.3
by Jonathan Lange
Mention the pydoctor dependency. |
19 |
|
20 |
To generate the API documentation, you'll also need to install 'pydoctor'. |
|
21 |
||
278.1.1
by Jonathan Lange
Whitespace cleanup |
22 |
Please refer to your system documentation for information on how to install
|
196
by Lionel Dricot
changelog |
23 |
these modules if they're not currently available. |
169.2.1
by Lionel Dricot
README file |
24 |
|
278.1.1
by Jonathan Lange
Whitespace cleanup |
25 |
To install these packages on Debian-based systems, execute the following |
196
by Lionel Dricot
changelog |
26 |
command: |
228.1.1
by wiz
There should be no commas between package names in aptitude |
27 |
$ sudo aptitude install python-gtk2 python-glade2 python-xdg python-gobject\ |
278.1.3
by Jonathan Lange
Mention the pydoctor dependency. |
28 |
python-configobj python-pydoctor |
169.2.1
by Lionel Dricot
README file |
29 |
|
278.1.13
by Jonathan Lange
Warn about karmic |
30 |
Note that the python-pydoctor package is broken in karmic. |
31 |
||
169.2.1
by Lionel Dricot
README file |
32 |
===== Installing and Running ===== |
33 |
||
196
by Lionel Dricot
changelog |
34 |
To install GTG, either unpack the tarball: |
278.1.1
by Jonathan Lange
Whitespace cleanup |
35 |
|
196
by Lionel Dricot
changelog |
36 |
$ tar xzvf gtg.tar.gz |
169.2.1
by Lionel Dricot
README file |
37 |
|
278.1.1
by Jonathan Lange
Whitespace cleanup |
38 |
or check out our bazaar branch for a development version (we try to keep those |
196
by Lionel Dricot
changelog |
39 |
unbroken and ready for production use): |
278.1.1
by Jonathan Lange
Whitespace cleanup |
40 |
|
169.2.1
by Lionel Dricot
README file |
41 |
$ bzr branch lp:gtg |
42 |
||
196
by Lionel Dricot
changelog |
43 |
To run GTG, either execute it directly from the source folder: |
169.2.1
by Lionel Dricot
README file |
44 |
|
45 |
$ cd gtg/ |
|
46 |
$ ./gtg |
|
47 |
||
196
by Lionel Dricot
changelog |
48 |
or install it system-wide (must install as root to install system-wide): |
169.2.1
by Lionel Dricot
README file |
49 |
|
50 |
$ cd gtg |
|
196
by Lionel Dricot
changelog |
51 |
$ sudo python setup.py install # must be root to install system-wide |
169.2.1
by Lionel Dricot
README file |
52 |
$ gtg |
53 |
||
271
by Luca Falavigna
Document usage of --install-layout=deb option for Ubuntu |
54 |
Please note you have to pass --install-layout=deb option to setup.py script |
55 |
to correctly install GTG on recent Ubuntu versions (9.04 "Jaunty" or later): |
|
56 |
||
57 |
$ sudo python setup.py install --install-layout=deb |
|
58 |
||
169.2.1
by Lionel Dricot
README file |
59 |
==== Usage ==== |
60 |
||
196
by Lionel Dricot
changelog |
61 |
When writing a task, keep in mind that: |
62 |
1) A line beginning with "-" will automatically create a subtask on that line |
|
63 |
2) A word beginning with "@" is a tag |
|
169.2.1
by Lionel Dricot
README file |
64 |
|
253
by Lionel Dricot
readme update by michael vogt |
65 |
===== Quick add ===== |
66 |
||
278.1.2
by Jonathan Lange
Spelling mistake. |
67 |
In the quickadd line you can use "attribute:argument" with any title. |
253
by Lionel Dricot
readme update by michael vogt |
68 |
Valid attributes are: "tags", "defer", "due" |
69 |
E.g.: |
|
70 |
"due:friday task description"
|
|
71 |
"more work due:today"
|
|
72 |
"due:tomorrow foo work"
|
|
73 |
"my bar task tags:@foo"
|
|
74 |
||
75 |
||
169.2.1
by Lionel Dricot
README file |
76 |
Please refer to http://gtg.fritalk.com/pages/documentation |
77 |
||
78 |
===== Want to know more? ===== |
|
79 |
||
196
by Lionel Dricot
changelog |
80 |
* GTG Website: http://gtg.fritalk.com/ |
81 |
* GTG project page on Launchpad: https://launchpad.net/gtg |
|
213.1.3
by Bertrand Rousseau
Add wiki url in README + s/Gnome/GNOME/ |
82 |
* GTG Wiki: http://live.gnome.org/gtg/ |
860
by Bryce Harrington
Include mention of the code documentation available online |
83 |
* GTG code documentation: http://allievi.sssup.it/GTG/ |