added README
[ptask.git] / README
1 ptask README
2 ==============
3
4 Introduction
5 ------------
6
7 +ptask+ is a GTK+ graphical user interface of +taskwarrior+, a command
8 line tasks manager.
9
10 Installation Using Distribution Packages
11 ----------------------------------------
12
13 Ubuntu
14 ~~~~~~
15
16 To install +ptask+, the easiest way is to use the dedicated PPA:
17 -------------------------------------
18 sudo apt-add-repository ppa:jfi/ptask
19 sudo apt-get update
20 sudo apt-get install ptask
21 -------------------------------------
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
45 autopoint help2man libgtk-3-dev libjson0-dev make perl
46 -------------------------------------------------------------------------
47
48 Contact
49 -------
50
51 Bugs and comments can be sent to jeanfi@gmail.com.
52
53 Home page: http://wpitchoune.net/ptask
54
55 Release changes: link:NEWS.html[NEWS]