X-Git-Url: https://git.wpitchoune.net/gitweb/?p=prss.git;a=blobdiff_plain;f=doc%2Findex.txt;h=5e84891047e611c99d9a4e24df147bf8bd9345d2;hp=4d07b83fefad1901a88ff4d90ffd1618527cad3a;hb=4535a6dd0da0868476e3f1cd01da9f0fd7b8f072;hpb=730688f91774c1f0166342071ca470451de1965e diff --git a/doc/index.txt b/doc/index.txt index 4d07b83..5e84891 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -3,8 +3,46 @@ PRSS PRSS is a GTK+ client application for Tiny Tiny RSS. +Installation from sources +------------------------- + +Build prerequisites +~~~~~~~~~~~~~~~~~~~ + +To compile PRSS, the following librairies and tools must be installed: + + * asciidoc + * autoconf + * automake + * autopoint + * cppcheck + * gettext + * help2man + * CURL library + * GTK+ 3 library + * JSON-C library + * GTK+ Webkit 2 library + * perl + +For Ubuntu 13.04, the following list of packages must be installed: + + * asciidoc + * autoconf + * automake + * autopoint + * debhelper + * cppcheck + * gettext + * help2man + * libcurl4-gnutls-dev + * libgtk-3-dev + * libjson0-dev + * libwebkitgtk-3.0-dev + * perl + + Download sources ----------------- +~~~~~~~~~~~~~~~~ Download a source archive from http://wpitchoune.net/prss/files or checkout the last development sources from the repository: @@ -12,22 +50,34 @@ checkout the last development sources from the repository: svn co http://wpitchoune.net/svnpub/prss/trunk ----------------------------- -Installation from source archive --------------------------------- +Compilation and installation of PRSS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In the directory of the sources: + ----------------------------- ./configure make clean all sudo make install ----------------------------- -Ubuntu: Installation Using PPA ------------------------------- - +Installation from PPA +--------------------- +For Ubuntu 12.04, 12.10 and 13.04: ------------------------------ sudo apt-add-repository ppa:jfi/prss sudo apt-get update sudo apt-get install ------------------------------ + +Configuration +------------- + +Open the web interface of Tiny Tiny RSS, login, open the preferences, +set +Enable external API+ to +Yes+ and click on the button +Save +configuration+. + +Launch PRSS, click on the button 'Preferences' in the toolbar, set +the +URL+ to +http://server_hostname/tt-rss+, and set the login and +password fields.