improved doc

[ptask.git] / README.html

diff --git a/README.html b/README.html
index 40ecbea..ff55b9b 100644 (file)
--- a/README.html
+++ b/README.html
@@ -90,7 +90,7 @@ code, pre, tt {
 }\r
 \r
 pre {\r
-    background: none repeat scroll 0 0 #f0f0f0;\r
+    background: none repeat scroll 0 0 #e0e0e0;\r
     border-radius: 4px;\r
     padding: 0.5em 0.5em;\r
     margin: 0 0 0 0;\r
@@ -323,8 +323,18 @@ asciidoc.install(2);
 <div id="content">\r
 <div id="preamble">\r
 <div class="sectionbody">\r
-<div class="paragraph"><p><tt>ptask</tt> is a GTK+ graphical user interface for <tt>taskwarrior</tt>, a command\r
-line tasks manager.</p></div>\r
+<div class="paragraph"><p><tt>ptask</tt> is a GTK+ graphical user interface for managing tasks.</p></div>\r
+<div class="paragraph"><p>It is based on <a href="http://taskwarrior.org">taskwarrior</a>, a well-known and robust command line\r
+tasks manager.</p></div>\r
+<div class="paragraph"><p>Unlike <tt>taskwarrior</tt>, it is possible to associate a note (long\r
+description) to each task.</p></div>\r
+<div class="paragraph"><p><tt>ptask</tt> is licensed under the GPLv2 terms and should compile on any\r
+modern GNU/Linux distribution.</p></div>\r
+<div class="paragraph"><p><strong>Home page</strong>: <a href="http://wpitchoune.net/ptask">http://wpitchoune.net/ptask</a>.</p></div>\r
+<div class="paragraph"><p><strong>RSS feed</strong>: <a href="http://wpitchoune.net/blog/category/ptask/feed/">http://wpitchoune.net/blog/category/ptask/feed/</a>.</p></div>\r
+<div class="paragraph"><p><strong>Release changes</strong>: <a href="NEWS.html">NEWS</a>.</p></div>\r
+<div class="paragraph"><p><strong>Source tarballs</strong>: <a href="http://wpitchoune.net/ptask/files">http://wpitchoune.net/ptask/files</a>.</p></div>\r
+<div class="paragraph"><p><strong>Documentation</strong>: <a href="http://wpitchoune.net/ptask/doc">http://wpitchoune.net/ptask/doc</a>.</p></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -349,7 +359,7 @@ development snapshot. It should only be used for testing purpose.</p></div>
 <div class="paragraph"><p><tt>ptask</tt> can be compiled and installed on any modern GNU/Linux\r
 distribution.</p></div>\r
 <div class="sect2">\r
-<h3 id="_compilation_prerequisites">2.1. Compilation Prerequisites</h3>\r
+<h3 id="_prerequisites">2.1. Prerequisites</h3>\r
 <div class="paragraph"><p>The compilation of <tt>ptask</tt> requires:</p></div>\r
 <div class="ulist"><ul>\r
 <li>\r
@@ -359,6 +369,11 @@ asciidoc
 </li>\r
 <li>\r
 <p>\r
+autotools\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
 cppcheck (optional, static source checker)\r
 </p>\r
 </li>\r
@@ -394,8 +409,31 @@ make
 <pre><tt>sudo apt-get install autoconf automake asciidoc cppcheck gcc gettext autopoint help2man libgtk-3-dev libjson0-dev make perl</tt></pre>\r
 </div></div>\r
 </div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_download_sources">3. Download sources</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Download a source tarballs and extracts its content:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>mkdir TMP_DIR\r
+cd TMP_DIR\r
+wget http://wpitchoune.net/ptask/files/ptask-last.tar.gz\r
+tar -xzvf ptask-last.tar.gz\r
+cd ptask-*</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>Alternatively, you can get the last developmenet snapshot of the\r
+sources directly from the SVN source repository:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>mkdir TMP_DIR\r
+cd TMP_DIR\r
+svn co http://wpitchoune.net/svnpub/ptask/trunk\r
+cd trunk</tt></pre>\r
+</div></div>\r
 <div class="sect2">\r
-<h3 id="_compilation">2.2. Compilation</h3>\r
+<h3 id="_compilation">3.1. Compilation</h3>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>./configure\r
@@ -403,7 +441,7 @@ make clean all</tt></pre>
 </div></div>\r
 </div>\r
 <div class="sect2">\r
-<h3 id="_installation">2.3. Installation</h3>\r
+<h3 id="_installation">3.2. Installation</h3>\r
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt>make install</tt></pre>\r
@@ -412,18 +450,16 @@ make clean all</tt></pre>
 </div>\r
 </div>\r
 <div class="sect1">\r
-<h2 id="_contact">3. Contact</h2>\r
+<h2 id="_contact">4. Contact</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>Bugs and comments can be sent to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</a>.</p></div>\r
-<div class="paragraph"><p>Home page: <a href="http://wpitchoune.net/ptask">http://wpitchoune.net/ptask</a></p></div>\r
-<div class="paragraph"><p>Release changes: <a href="NEWS.html">NEWS</a></p></div>\r
 </div>\r
 </div>\r
 </div>\r
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2013-11-24 22:55:07 CET\r
+Last updated 2013-11-27 09:07:46 CET\r
 </div>\r
 </div>\r
 </body>\r