added ptask

[www.git] / src / ptask / ptask.adoc

diff --git a/src/ptask/ptask.adoc b/src/ptask/ptask.adoc
new file mode 100644 (file)
index 0000000..e909468
--- /dev/null
+++ b/src/ptask/ptask.adoc
@@ -0,0 +1,113 @@
+= ptask
+:docinfo2:
+:icon: font
+
+`ptask` is a GTK+ graphical user interface for managing tasks.
+
+It is based on link:http://taskwarrior.org[taskwarrior], a well-known
+and robust command line tasks manager.
+
+Unlike `taskwarrior`, it is possible to associate a note (long
+description) to each task.
+
+The following releases of `taskwarrior` are supported:
+
+* 2.0.0
+* 2.2.0
+* 2.3.0
+* 2.4.0, 2.4.1
+* 2.5
+
+`ptask` is licensed under the GPLv2 terms and should compile on any
+modern GNU/Linux distribution.
+
+image:screenshots/ptask20131201.png[]
+
+== Installation on Ubuntu
+
+To install `ptask` on Ubuntu and derivates, the easiest way is to use
+the dedicated PPA:
+
+----
+sudo apt-add-repository ppa:jfi/ptask
+sudo apt-get update
+sudo apt-get install ptask
+----
+
+The PPA `ppa:jfi/ptask` contains the binary package of the last released
+version of ptask for the last released version of Ubuntu.
+
+== Installation from source archive
+
+`ptask` can be compiled and installed on any modern GNU/Linux distribution.
+
+=== Prerequisites
+
+The compilation of ptask requires:
+
+* asciidoc
+
+* autotools
+
+* cppcheck (optional, static source checker)
+
+* gcc
+
+* help2man
+
+* library gtk3
+
+* library json-c
+
+* make
+
+For Ubuntu 12.10:
+
+----
+sudo apt-get install autoconf automake asciidoc cppcheck gcc gettext autopoint help2man libgtk-3-dev libjson0-dev make perl
+---
+
+=== Download sources
+
+Download a source tarballs of a release and extracts its content:
+
+----
+mkdir TMP_DIR
+cd TMP_DIR
+wget http://wpitchoune.net/ptask/files/ptask-last.tar.gz
+tar -xzvf ptask-last.tar.gz
+cd ptask-*
+----
+
+Alternatively, you can get the last development snapshot of the
+sources directly from the GIT source repository:
+
+----
+mkdir TMP_DIR
+cd TMP_DIR
+git clone http://git.wpitchoune.net/ptask.git
+cd ptask
+----
+
+=== Compilation
+
+----
+./configure
+make clean all
+----
+
+=== Installation
+
+----
+make install
+----
+
+== Resources
+
+* Home page: http://wpitchoune.net/ptask.
+
+* Source tarballs: http://wpitchoune.net/ptask/files.
+
+== Contact
+
+Bugs and comments can be sent to jeanfi@gmail.com.