Updated Documentation (markdown)

martinrotter 2020-11-04 13:59:43 +01:00
parent 97e6141c4b
commit 1e5c376cdb
1 changed files with 55 additions and 1 deletions

@ -1 +1,55 @@
# **WIP**
# **WIP**
Contacts
--------
* [author's e-mail](mailto:rotter.martinos@gmail.com).
Donate
------
See **Sponsor** button on the top of this page. **I say "thank you" for all your support, donators.**
Thanks to
-----
I personally send "thank you" to all contributors (translators, source code contributors, issue reporters) and users.
Philosophy
----------
RSS Guard tends to be independent software. It's free, it's open-source. RSS Guard accepts donations but only as a way of saying "thank you for RSS Guard".
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.
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 **FALLBACK** settings). If this file is not found, then application will check if its root path (folder in which RSS Guard executable is installed) is writable, and if it is, it will store settings in it, in subfolder:
```
data\config\config.ini
```
This is fully-portable mode.
Otherwise, standard "config" folder is used. Check "About RSS Guard" dialog to find more info.
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:
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.
**All translators commit themselves to 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.**