improvements
[ptask.git] / README
1 ptask README
2 ==============
3
4 +ptask+ is a GTK+ graphical user interface for +taskwarrior+, a command
5 line tasks manager.
6
7 Installation on Ubuntu
8 ----------------------
9
10 To install +ptask+ on Ubuntu and derivates, the easiest way is to use the dedicated PPA:
11 -------------------------------------
12 sudo apt-add-repository ppa:jfi/ptask
13 sudo apt-get update
14 sudo apt-get install ptask
15 -------------------------------------
16
17 The PPA +ppa:jfi/ptask+ contains the binary package of the last
18 released version of +ptask+ for the last released version of Ubuntu.
19
20 The PPA +ppa:jfi/ptask-daily+ contains the binary package of the last
21 development snapshot. It should only be used for testing purpose.
22
23 Installation from source archive
24 --------------------------------
25
26 +ptask+ can be compiled and installed on any modern GNU/Linux
27 distribution.
28
29 Compilation Prerequisites
30 ~~~~~~~~~~~~~~~~~~~~~~~~~
31
32 The compilation of +ptask+ requires:
33
34  * asciidoc
35  * cppcheck (optional, static source checker)
36  * gcc
37  * help2man
38  * library gtk3
39  * library json-c
40  * make
41
42 For Ubuntu 12.10:
43 -------------------------------------------------------------------------
44 sudo apt-get install autoconf automake asciidoc cppcheck gcc gettext autopoint help2man libgtk-3-dev libjson0-dev make perl
45 -------------------------------------------------------------------------
46
47 Compilation
48 ~~~~~~~~~~~
49
50 -------------------------------
51 ./configure
52 make clean all
53 -------------------------------
54
55 Installation
56 ~~~~~~~~~~~~
57
58 -------------------------------
59 make install
60 -------------------------------
61
62 Contact
63 -------
64
65 Bugs and comments can be sent to jeanfi@gmail.com.
66
67 Home page: http://wpitchoune.net/ptask
68
69 Release changes: link:NEWS.html[NEWS]