FreshRSS
/
rssguard
mirror of https://github.com/martinrotter/rssguard.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

martinrotter 2016-08-16 09:20:48 +02:00
parent 311238c4f5
commit 30ddf1089b
1 changed files with 31 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
Home.md

@ -2,20 +2,19 @@ RSS Guard
=========
Welcome to RSS Guard wiki! Please, make yourself comfortable here.
- - -
Versioning
---------------
----------
RSS Guard uses semantic versioning. The versioning scheme is `X.Y.Z`, where:
* `X` marks major release version. This number will change very rarely and indicates critical new changes breaking backward compatibility.
* `Y` indicates that there is new major feature available.
* `Z` indicates that there are newly fixed bugs or small features introduced.
- - -
Issue reporting
---------------
Please, report all issues/bugs/ideas to [Issues](https://github.com/martinrotter/rssguard/issues) section. Describe your problem as precisely as possible.
- - -
Compilation
------------
You need to compile RSS Guard if binary distribution is not available for your platform. Basic steps are really simple:
@ -30,9 +29,9 @@ make INSTALL_ROOT=./app install
RSS Guard is compilable only and only with Qt 5.7+. You also need C++ 11 compiler. Note that if you clone Git repository and you wish to make packages for Windows, then you must initialize all submodules within obtained repository before compilation.
For more information, refere to file [rssguard.pro](https://raw.githubusercontent.com/martinrotter/rssguard/master/rssguard.pro).
- - -
Generating debug log file
--------------
-------------------------
If you run into problems with RSS Guard and you need your problems fixed, you should provide log file from the time when problem occurred. RSS Guard writes all important information to standard output, which is usually calling terminal.
To redirect debug output of RSS Guard to log file, do this:
@ -51,7 +50,6 @@ To redirect debug output of RSS Guard to log file, do this:
4. Now try to simulate your problem.
5. Attach generated `log.txt` file to your bug report.
- - -
Portable setup
--------------
RSS Guard checks "home directory" (this is "C:\Users\<user>\" directory on Windows) for existence of file:
@ -63,9 +61,32 @@ If that file exists, then RSS Guard will use the file (non-portable settings). I
data\config\config.ini
```
This is fully-portable mode.
- - -
Server/client cron-like mode
----------------------------
RSS Guard supports server/client mode which enables you to fetch your message to your data server and then use those data and view them in another RSS Guard instance.
On the server:
1. Install RSS Guard to your data server.
2. Install MariaDB SQL server.
3. Start SQL server and launch RSS Guard with GUI.
4. Set MariaDB SQL server as RSS Guard data storage and restart RSS Guard.
5. Setup RSS Guard to periodically check for feeds/messages updates and load desired feeds.
6. Now, start RSS Guard in non-gui minimal mode with `rssguard -c` command. You can start this command after your server boots.
Now your RSS Guard server instance is ready and running. It will check for new messages periodically and store them to MariaDB SQL server. Now, you need to setup your client.
On the client machine:
1. Install and launch RSS Guard.
2. Set MariaDB SQL server as RSS Guard data storage and restart RSS Guard.
3. Now, you should see feeds/messages which were fetched by RSS Guard server instance.
Goal of this approach is that your RSS Guard server instance can run forever and check for new messages even when you sleep. You then just launch RSS Guard in your client machine, and all messages will be there.
Localizations
-----------------------
-------------
RSS Guard currently includes [many localizations](http://www.transifex.com/projects/p/rssguard).
If you are interested in creating translations for RSS Guard, then do this:
@ -76,4 +97,3 @@ If you are interested in creating translations for RSS Guard, then do this:
Alternatively, you can check [localization files](https://github.com/martinrotter/rssguard/tree/master/localization) by yourself and use [Qt Linguist](http://doc.qt.io/qt-5/qtlinguist-index.html) for translating them.
**All translators commit themselves too keep their translations up-to-date. If some translations are not updated by their authors regularly and only small number of strings is translated, then those translations along with their teams will be eventually REMOVED from the project !!! At least 50% of strings must be translated for translation to being added to project.**
- - -