(no commit message)
[prss.git] / doc / index.txt
1 PRSS
2 ====
3
4 PRSS is a GTK+ client application for Tiny Tiny RSS.
5
6 Installation from sources
7 -------------------------
8
9 Build prerequisites
10 ~~~~~~~~~~~~~~~~~~~
11
12 To compile PRSS, the following librairies and tools must be installed:
13
14  * asciidoc
15  * autoconf
16  * automake
17  * autopoint
18  * cppcheck
19  * gettext
20  * help2man
21  * CURL library
22  * GConf2 library
23  * GTK+ 3 library
24  * JSON-C library
25  * GTK+ Webkit 2 library
26  * perl
27
28 For Ubuntu 13.04, the following list of packages must be installed:
29
30  * asciidoc
31  * autoconf
32  * automake
33  * autopoint
34  * debhelper
35  * cppcheck
36  * gettext
37  * help2man
38  * libcurl4-gnutls-dev
39  * libgconf2-dev
40  * libgtk-3-dev
41  * libjson0-dev
42  * libwebkitgtk-3.0-dev
43  * perl
44
45
46 Download sources
47 ~~~~~~~~~~~~~~~~
48
49 Download a source archive from http://wpitchoune.net/prss/files or
50 checkout the last development sources from the repository:
51 -----------------------------
52 svn co http://wpitchoune.net/svnpub/prss/trunk
53 -----------------------------
54
55 Compilation and installation of PRSS
56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57
58 In the directory of the sources:
59
60 -----------------------------
61 ./configure
62 make clean all
63 sudo make install
64 -----------------------------
65
66 Installation from PPA
67 ---------------------
68
69 ------------------------------
70 sudo apt-add-repository ppa:jfi/prss
71 sudo apt-get update
72 sudo apt-get install
73 ------------------------------
74
75 Configuration
76 -------------
77
78 Open the web interface of Tiny Tiny RSS, login, open the preferences,
79 set +Enable external API+ to +Yes+ and click on the button +Save
80 configuration+.
81
82 Launch PRSS, click on the button 'Preferences' in the toolbar, set
83 the +URL+ to +http://server_hostname/tt-rss+, and set the login and
84 password fields.