README

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