recent version of libjson has remove is_error which was checking

[ptask.git] / README

diff --git a/README b/README
index 2bc5c65..b1ba196 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,16 @@
 ptask README
 ==============
 
-+ptask+ is a GTK+ graphical user interface for +taskwarrior+, a command
-line tasks manager.
++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.
+
++ptask+ is licensed under the GPLv2 terms and should compile on any
+modern GNU/Linux distribution.
 
 Installation on Ubuntu
 ----------------------
@@ -26,16 +34,17 @@ Installation from source archive
 +ptask+ can be compiled and installed on any modern GNU/Linux
 distribution.
 
-Compilation Prerequisites
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Prerequisites
+~~~~~~~~~~~~~
 
 The compilation of +ptask+ requires:
 
  * asciidoc
+ * autotools
  * cppcheck (optional, static source checker)
  * gcc
  * help2man
- * library gtk3
+ * library gtk3 >= 3.12
  * library json-c
  * make
 
@@ -44,6 +53,28 @@ 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 SVN source repository:
+
+-------------------------------
+mkdir TMP_DIR
+cd TMP_DIR
+svn co http://wpitchoune.net/svnpub/ptask/trunk
+cd trunk
+-------------------------------
+
 Compilation
 ~~~~~~~~~~~
 
@@ -59,11 +90,16 @@ Installation
 make install
 -------------------------------
 
+Resources
+---------
+
+ * *Home page*: http://wpitchoune.net/ptask.
+ * *RSS feed*: http://wpitchoune.net/blog/category/ptask/feed/.
+ * *Release changes*: link:NEWS.html[NEWS].
+ * *Source tarballs*: http://wpitchoune.net/ptask/files.
+ * *Documentation*: http://wpitchoune.net/ptask/doc.
+
 Contact
 -------
 
 Bugs and comments can be sent to jeanfi@gmail.com.
-
-Home page: http://wpitchoune.net/ptask
-
-Release changes: link:NEWS.html[NEWS]
\ No newline at end of file