From 7bd26dc532cf4069ee87a0399ad7e10f52240575 Mon Sep 17 00:00:00 2001 From: Jean-Philippe Orsini Date: Wed, 27 Nov 2013 08:08:55 +0000 Subject: [PATCH] improved doc --- NEWS.html | 2 +- README | 52 +++++++++++++++++++++++++++++++++++++++++++++------- README.html | 56 ++++++++++++++++++++++++++++++++++++++++++++++---------- style.css | 2 +- 4 files changed, 93 insertions(+), 19 deletions(-) diff --git a/NEWS.html b/NEWS.html index ff4696b..6b9a207 100644 --- a/NEWS.html +++ b/NEWS.html @@ -90,7 +90,7 @@ code, pre, tt { } pre { - background: none repeat scroll 0 0 #f0f0f0; + background: none repeat scroll 0 0 #e0e0e0; border-radius: 4px; padding: 0.5em 0.5em; margin: 0 0 0 0; diff --git a/README b/README index 2bc5c65..346b145 100644 --- a/README +++ b/README @@ -1,8 +1,26 @@ 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. + +*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. Installation on Ubuntu ---------------------- @@ -26,12 +44,13 @@ 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 @@ -44,6 +63,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 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 developmenet 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 ~~~~~~~~~~~ @@ -64,6 +105,3 @@ 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 diff --git a/README.html b/README.html index 40ecbea..ff55b9b 100644 --- a/README.html +++ b/README.html @@ -90,7 +90,7 @@ code, pre, tt { } pre { - background: none repeat scroll 0 0 #f0f0f0; + background: none repeat scroll 0 0 #e0e0e0; border-radius: 4px; padding: 0.5em 0.5em; margin: 0 0 0 0; @@ -323,8 +323,18 @@ asciidoc.install(2);
-

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 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.

+

Home page: http://wpitchoune.net/ptask.

+

RSS feed: http://wpitchoune.net/blog/category/ptask/feed/.

+

Release changes: NEWS.

+

Source tarballs: http://wpitchoune.net/ptask/files.

+

Documentation: http://wpitchoune.net/ptask/doc.

@@ -349,7 +359,7 @@ development snapshot. It should only be used for testing purpose.

ptask can be compiled and installed on any modern GNU/Linux distribution.

-

2.1. Compilation Prerequisites

+

2.1. Prerequisites

The compilation of ptask requires:

  • @@ -359,6 +369,11 @@ asciidoc

  • +autotools +

    +
    • +
  • +

    cppcheck (optional, static source checker)

    • @@ -394,8 +409,31 @@ make 
    sudo apt-get install autoconf automake asciidoc cppcheck gcc gettext autopoint help2man libgtk-3-dev libjson0-dev make perl
+ + +
+

3. Download sources

+
+

Download a source tarballs 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 developmenet 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
+
-

2.2. Compilation

+

3.1. Compilation

./configure
@@ -403,7 +441,7 @@ make clean all
-

2.3. Installation

+

3.2. Installation

make install
@@ -412,18 +450,16 @@ make clean all
-

3. Contact

+

4. Contact

Bugs and comments can be sent to jeanfi@gmail.com.

-

Home page: http://wpitchoune.net/ptask

-

Release changes: NEWS

diff --git a/style.css b/style.css index c08b0b4..1ec7848 100644 --- a/style.css +++ b/style.css @@ -82,7 +82,7 @@ code, pre, tt { } pre { - background: none repeat scroll 0 0 #f0f0f0; + background: none repeat scroll 0 0 #e0e0e0; border-radius: 4px; padding: 0.5em 0.5em; margin: 0 0 0 0; -- 2.7.4