Initial Home page.

Home.md

@@ -0,0 +1,69 @@
+RSS Guard
+=========
+
+Welcome to RSS Guard wiki! Please, make yourself comfortable here.
+
+**[Versioning](#markdown-header-versioning) | [Issue reporting](#markdown-header-issue-reporting) | [Compilation](#markdown-header-compilation) | [Portable setup](#markdown-header-portable-setup) | [Localizations](#markdown-header-localizations) | [Tutorial](Tutorial)**
+- - -
+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
+---------------
+You can report bug or request new feature in "Issues" section of this website. You DO NOT HAVE TO register for doing so. Please, make your reports readable, simple and comprehensive.
+
+**You can also report bugs on [GitHub mirror](https://github.com/martinrotter/rssguard) of this repository.**
+- - -
+Compilation
+------------
+You need to compile RSS Guard if binary distribution is not available for your platform. Basic steps are really simple:
+```
+cd ...../rssguard-git-master
+mkdir ../rssguard-build
+cd ../rssguard-build
+qmake ../rssguard-git-master/rssguard.pro -r CONFIG+=release PREFIX=/usr INSTALL_ROOT=./app
+make
+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).
+- - -
+Portable setup
+--------------
+RSS Guard checks "home directory" (this is "C:\Users\<user>\" directory on Windows) for existence of file:
+```
+.rssguard\data\config\config.ini
+```
+If that file exists, then RSS Guard will use the file (non-portable settings). If this file is not found, then application will check if its root path (folder in which RSS Guard is installed) is writtable, and if it is, it will store settings in it, in subfolder:
+```
+data\config\config.ini
+```
+This is fully-portable mode.
+- - -
+Localizations
+-----------------------
+RSS Guard currently supports these localizations:
+
+* Czech (Czech Republic),
+* Dutch (Netherlands),
+* English (Great Britain),
+* French (France),
+* German (Germany),
+* Italian (Italy),
+* Portuguese (Brazil),
+* Swedish (Sweden).
+
+If you are interested in creating translations for RSS Guard, then do this:
+
+1. Go [here](http://www.transifex.com/projects/p/rssguard) and check status of currently supported localizations.
+2. [Login](http://www.transifex.com/signin) (you can use social networks to login) and work on existing translations. If no translation team for your country/language exists, then ask for creating of localization team via the website. When requesting new localization, please specify full locale (country + language), for example "de_DE". You can find codes [here](http://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx). Use underscore instead of dash, for example use "de_DE" and not "de-DE".
+
+Alternatively, you can check [localization files](https://bitbucket.org/skunkos/rssguard/raw/master/localization?at=master) by yourself and use [Qt Linguist](http://qt-project.org/doc/qt-4.8/linguist-manual.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.**