switched source to git
[prss.git] / doc / index.html
index fead778..cc951ff 100644 (file)
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.7" />\r
+<meta name="generator" content="AsciiDoc 8.6.9" />\r
 <title>PRSS</title>\r
 <style type="text/css">\r
 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
@@ -87,10 +87,16 @@ ul, ol, li > p {
 ul > li     { color: #aaa; }\r
 ul > li > * { color: black; }\r
 \r
-pre {\r
+.monospaced, code, pre {\r
+  font-family: "Courier New", Courier, monospace;\r
+  font-size: inherit;\r
+  color: navy;\r
   padding: 0;\r
   margin: 0;\r
 }\r
+pre {\r
+  white-space: pre-wrap;\r
+}\r
 \r
 #author {\r
   color: #527bbd;\r
@@ -219,7 +225,7 @@ div.exampleblock > div.content {
 }\r
 \r
 div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
 a.image:visited { color: white; }\r
 \r
 dl {\r
@@ -415,12 +421,6 @@ div.unbreakable { page-break-inside: avoid; }
  *\r
  * */\r
 \r
-tt {\r
-  font-family: "Courier New", Courier, monospace;\r
-  font-size: inherit;\r
-  color: navy;\r
-}\r
-\r
 div.tableblock {\r
   margin-top: 1.0em;\r
   margin-bottom: 1.5em;\r
@@ -454,12 +454,6 @@ div.tableblock > table[frame="vsides"] {
  *\r
  * */\r
 \r
-.monospaced {\r
-  font-family: "Courier New", Courier, monospace;\r
-  font-size: inherit;\r
-  color: navy;\r
-}\r
-\r
 table.tableblock {\r
   margin-top: 1.0em;\r
   margin-bottom: 1.5em;\r
@@ -539,6 +533,8 @@ body.manpage div.sectionbody {
 @media print {\r
   body.manpage div#toc { display: none; }\r
 }\r
+\r
+\r
 </style>\r
 <script type="text/javascript">\r
 /*<![CDATA[*/\r
@@ -746,14 +742,201 @@ asciidoc.install(2);
 <div id="content">\r
 <div id="preamble">\r
 <div class="sectionbody">\r
-<div class="paragraph"><p>PRSS is a GTK+ client application for Tiny Tiny RSS.</p></div>\r
+<div class="paragraph"><p>PRSS is a GNOME/GTK+ client application for Tiny Tiny RSS.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_installation_from_sources">1. Installation from sources</h2>\r
+<div class="sectionbody">\r
+<div class="sect2">\r
+<h3 id="_build_prerequisites">1.1. Build prerequisites</h3>\r
+<div class="paragraph"><p>To compile PRSS, the following librairies and tools must be installed:</p></div>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+asciidoc\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+autoconf\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+automake\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+autopoint\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+cppcheck\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+gettext\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+help2man\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+CURL library\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+GTK+ 3 library\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+JSON-C library\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+GTK+ Webkit 2 library\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+perl\r
+</p>\r
+</li>\r
+</ul></div>\r
+<div class="paragraph"><p>For Ubuntu 13.04, the following list of packages must be installed:</p></div>\r
+<div class="ulist"><ul>\r
+<li>\r
+<p>\r
+asciidoc\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+autoconf\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+automake\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+autopoint\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+debhelper\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+cppcheck\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+gettext\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+help2man\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+libcurl4-gnutls-dev\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+libgtk-3-dev\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+libjson0-dev\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+libwebkitgtk-3.0-dev\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+perl\r
+</p>\r
+</li>\r
+</ul></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_download_sources">1.2. Download sources</h3>\r
+<div class="paragraph"><p>Download a source archive from <a href="http://wpitchoune.net/prss/files">http://wpitchoune.net/prss/files</a> or\r
+checkout the last development sources from the repository:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code>git git://git.wpitchoune.net/prss.git</code></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_compilation_and_installation_of_prss">1.3. Compilation and installation of PRSS</h3>\r
+<div class="paragraph"><p>In the directory of the sources:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code>./configure\r
+make clean all\r
+sudo make install</code></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_installation_from_ppa">2. Installation from PPA</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>For Ubuntu:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code>sudo apt-add-repository ppa:jfi/prss\r
+sudo apt-get update\r
+sudo apt-get install</code></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_configuration">3. Configuration</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Open the web interface of Tiny Tiny RSS, login, open the preferences,\r
+set <code>Enable external API</code> to <code>Yes</code> and click on the button <code>Save\r
+configuration</code>.</p></div>\r
+<div class="paragraph"><p>Launch PRSS, click on the button <em>Preferences</em> in the toolbar, set\r
+the <code>URL</code> to <code>http://server_hostname/tt-rss</code>, and set the login and\r
+password fields.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_contact">4. Contact</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Send questions, comments, or bugs to <a href="mailto:jeanfi@gmail.com">jeanfi@gmail.com</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-05-01 17:01:03 CEST\r
+Last updated 2014-04-22 19:43:16 CEST\r
 </div>\r
 </div>\r
 </body>\r