fixed code style
[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  * GTK+ 3 library
23  * JSON-C library
24  * GTK+ Webkit 2 library
25  * perl
26
27 For Ubuntu 13.04, the following list of packages must be installed:
28
29  * asciidoc
30  * autoconf
31  * automake
32  * autopoint
33  * debhelper
34  * cppcheck
35  * gettext
36  * help2man
37  * libcurl4-gnutls-dev
38  * libgtk-3-dev
39  * libjson0-dev
40  * libwebkitgtk-3.0-dev
41  * perl
42
43
44 Download sources
45 ~~~~~~~~~~~~~~~~
46
47 Download a source archive from http://wpitchoune.net/prss/files or
48 checkout the last development sources from the repository:
49 -----------------------------
50 svn co http://wpitchoune.net/svnpub/prss/trunk
51 -----------------------------
52
53 Compilation and installation of PRSS
54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55
56 In the directory of the sources:
57
58 -----------------------------
59 ./configure
60 make clean all
61 sudo make install
62 -----------------------------
63
64 Installation from PPA
65 ---------------------
66
67 For Ubuntu 12.04, 12.10 and 13.04:
68 ------------------------------
69 sudo apt-add-repository ppa:jfi/prss
70 sudo apt-get update
71 sudo apt-get install
72 ------------------------------
73
74 Configuration
75 -------------
76
77 Open the web interface of Tiny Tiny RSS, login, open the preferences,
78 set +Enable external API+ to +Yes+ and click on the button +Save
79 configuration+.
80
81 Launch PRSS, click on the button 'Preferences' in the toolbar, set
82 the +URL+ to +http://server_hostname/tt-rss+, and set the login and
83 password fields.