src/ptask/ptask.adoc

   1 = ptask
   2 :docinfo2:
   3 :icon: font
   4
   5 `ptask` is a GTK+ graphical user interface for managing tasks.
   6
   7 It is based on link:http://taskwarrior.org[taskwarrior], a well-known
   8 and robust command line tasks manager.
   9
  10 Unlike `taskwarrior`, it is possible to associate a note (long
  11 description) to each task.
  12
  13 The following releases of `taskwarrior` are supported:
  14
  15 * 2.0.0
  16 * 2.2.0
  17 * 2.3.0
  18 * 2.4.0, 2.4.1
  19 * 2.5
  20
  21 `ptask` is licensed under the GPLv2 terms and should compile on any
  22 modern GNU/Linux distribution.
  23
  24 image:screenshots/ptask20131201.png[]
  25
  26 == Installation on Ubuntu
  27
  28 To install `ptask` on Ubuntu and derivates, the easiest way is to use
  29 the dedicated PPA:
  30
  31 ----
  32 sudo apt-add-repository ppa:jfi/ptask
  33 sudo apt-get update
  34 sudo apt-get install ptask
  35 ----
  36
  37 The PPA `ppa:jfi/ptask` contains the binary package of the last released
  38 version of ptask for the last released version of Ubuntu.
  39
  40 == Installation from source archive
  41
  42 `ptask` can be compiled and installed on any modern GNU/Linux distribution.
  43
  44 === Prerequisites
  45
  46 The compilation of ptask requires:
  47
  48 * asciidoc
  49
  50 * autotools
  51
  52 * cppcheck (optional, static source checker)
  53
  54 * gcc
  55
  56 * help2man
  57
  58 * library gtk3
  59
  60 * library json-c
  61
  62 * make
  63
  64 For Ubuntu 12.10:
  65
  66 ----
  67 sudo apt-get install autoconf automake asciidoc cppcheck gcc gettext autopoint help2man libgtk-3-dev libjson0-dev make perl
  68 ----
  69
  70 === Download sources
  71
  72 Download a source tarballs of a release and extracts its content:
  73
  74 ----
  75 mkdir TMP_DIR
  76 cd TMP_DIR
  77 wget http://wpitchoune.net/ptask/files/ptask-last.tar.gz
  78 tar -xzvf ptask-last.tar.gz
  79 cd ptask-*
  80 ----
  81
  82 Alternatively, you can get the last development snapshot of the
  83 sources directly from the GIT source repository:
  84
  85 ----
  86 mkdir TMP_DIR
  87 cd TMP_DIR
  88 git clone http://git.wpitchoune.net/ptask.git
  89 cd ptask
  90 ----
  91
  92 === Compilation
  93
  94 ----
  95 ./configure
  96 make clean all
  97 ----
  98
  99 === Installation
 100
 101 ----
 102 make install
 103 ----
 104
 105 == Resources
 106
 107 * Home page: http://wpitchoune.net/ptask.
 108
 109 * Source tarballs: http://wpitchoune.net/ptask/files.
 110
 111 == Contact
 112
 113 Bugs and comments can be sent to jeanfi@gmail.com.