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