Update README and related

16 files changed, 156 insertions, 121 deletions

diff --git a/CREDITS.md b/CREDITS.md
index bb6c76da4..1460141ae 100644
--- a/CREDITS.md
+++ b/CREDITS.md
@@ -17,6 +17,14 @@ Credits
 A special thanks to spoob, sebnapi and RaNaN who created pyLoad!
 
 
+### Mantainers ###
+
+*(alphabetically sorted)*
+
+ - stickell (Stefano) <l.stickell@yahoo.it>
+ - vuolter (Walter Purcaro) <vuolter@gmail.com>
+
+
 ### Contributors ###
 
 The list of developers who have kindly contributed to the pyLoad project is constantly updated.
@@ -36,3 +44,7 @@ opening topic to share tips and advices, fix troubles or simply discuss about th
 
 
 #### The pyLoad Team can be only forever thankful to all of you for your amazing efforts! ####
+
+
+-----------------------------------
+###### pyLoad Team 2008-2015 ######
diff --git a/README.md b/README.md
index c0ddbc416..727c18e72 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 
 [![Translation Status](http://translate.pyload.org/badges/pyload/localized.png "Translation Status")](http://translate.pyload.org/project/pyload/)
 
-**pyLoad** is a Free and Open Source download manager written entirely in Python and designed to be extremely lightweight.
+**pyLoad** is a Free and Open Source download manager written in Python and designed to be extremely lightweight.
 
 pyLoad is available for all kind of operating systems and devices:
 You could install it on a computer, but also on a headless servers, a router, a smart usb-stick running linux... almost whatever you want!
@@ -17,70 +17,126 @@ Additionaly, pyLoad has a great variety of plugins to automate common tasks and
 pyLoad has a fully featured and well documented API, it's easily extendable and accessible by external tools, cross-platform apps or other softwares.
 
 
+Download & Installation
+-----------------------
+
+You can see all the pre-build packages of pyLoad here: <https://github.com/pyload/pyload/releases>.
+
+> **Note:**
+If you're on Windows, it's highly recommended to install the pre-build package instead getting the source code.
+
+Pre-build packages yet included all the software dependencies required to run pyLoad.
+
+By the way, you can install any missing software packages by the Python Package Index, typing:
+
+    pip install <package-name>
+
+You can download the latest stable source code here: <>.
+You can download the latest development source code here: <>.
+
+
 Dependencies
 ------------
 
- - **You need at least Python 2.5 or at most Python 2.7 to run pyLoad and its required software libraries**
+ - **You need at least Python 2.5 or at most Python 2.7 to run pyLoad and its required software packages**
  - **Python 3 and PyPy are not yet supported**
 
 ### Required ###
 
  - **Beaker**
- - **bottle**
  - **Getch**
+ - **MultipartPostHandler**
+ - **SafeEval**
+ - **bottle**
+ - **colorama**
  - **jinja2**
  - **markupsafe**
- - **MultipartPostHandler**
  - **pycurl** (python-curl)
  - **rename_process**
- - **SafeEval**
- - **simplejson** *required for JSON speedup*
+ - **setuptools**
  - **thrift**
  - **wsgiserver**
 
-Some addition features require additional packages.
 
+Some extra features require additional software packages. See below:
 
 ### Optional ###
 
- - **BeautifulSoup**
- - **bjoern** (<https://github.com/jonashaag/bjoern>) *required for a better webui experience*
- - **feedparser** *required for RSS parsing support*
- - **node.js** or **ossp-js** or **pyv8** or **rhino** or **spidermonkey** (JS Engines) *required by plugins like ClickNLoad to work correctly*
- - **PIL** (python-imaging) *required for captcha recognition support*
- - **pycrypto** *required for RSDF/CCF/DLC container decrypting*
- - **pyOpenSSL** *required for SSL connection support*
- - **tesseract** *required for captcha ocr support*
+ - **BeautifulSoup**                                  *Few plugins support*
+ - **PIL** (python-imaging)                           *Captcha recognition*
+ - **colorlog**                                       *Colored log*
+ - **bjoern** (<https://github.com/jonashaag/bjoern>) *More responsive web interface*
+ - **feedparser**                                     *RSS parsing*
+ - **node.js**                                        *ClickNLoad and other plugins*
+   - or **ossp-js**
+   - or **pyv8**
+   - or **rhino**
+   - or **spidermonkey**
+ - **pyOpenSSL**                                      *SSL support*
+ - **pycrypto**                                       *RSDF/CCF/DLC decrypting*
+ - **simplejson**                                     *JSON speedup*
+ - **tesseract**                                      *Captcha OCR support*
+
+
+Translations
+------------
 
-You can install them using the Python Package Index:
+The localization process take place on Crowdin: <http://crowdin.net/project/pyload>.
 
-    pip install <package-name>
 
+### Send a tip for translators ###
 
-### Included ###
+If you want to explain a translatable string to make the translation process easier you can do that using comment block starting with `L10N:`. For example:
 
- - **Beaker**
- - **BeautifulSoup**
- - **bottle**
- - **feedparser**
- - **Getch**
- - **jinja2**
- - **markupsafe**
- - **MultipartPostHandler**
- - **rename_process**
- - **SafeEval**
- - **simplejson**
- - **thrift**
- - **wsgiserver**
+    python
+    # L10N: Here the tip for translators
+    # Thanks
+    print _("A translatable string")
 
-> **Note:**
-Pre-build packages should yet include all.
+Translators will see:
+
+    L10N: Here the tip for translators
+    Thanks
+
+
+### Updating templates ###
+
+To update POT files type:
+
+    paver generate_locale
+
+To automatically upload the updated POTs on Crowdin for the localization process just type:
+
+    paver upload_translations -k [api_key]
+
+the API Key can be retrieved in the Settings panel of the project on Crowdin. This is allowed only to the administrators.
+
+
+### Retrieve PO files ###
+
+Updated PO files can be automatically download from Crowdin typing:
+
+    paver download_translations -k [api_key]
+
+This is allowed only to administrators, **users can download the last version of the translations using the Crowdin web interface**.
+
+
+### Compile PO files ###
+
+MO files can be generated typing:
+
+    paver compile_translations
+
+To compile a single file just use command `msgfmt`.
+For example to compile a core.po file type:
+
+    msgfmt -o core.mo core.po
 
 
 Usage
 -----
 
-### First start ###
+### First Start ###
 
 Run:
 
@@ -89,9 +145,9 @@ Run:
 and follow the setup assistant instructions.
 
 > **Note:**
-If you installed pyLoad by package-manager, command `python pyload.py` is probably equivalent to `pyload`.
+If you installed pyLoad by a package-manager, command `python pyload.py` might be equivalent to `pyload`.
 
-Additionally, you can whenever restart the setup assistant typing:
+If something go wrong, you can restart the setup assistant whenever you want, just typing:
 
     python pyload.py -s
 
@@ -106,7 +162,7 @@ Run:
 
     python pyload.py
 
-So, to retrieve it point your web browser to the socket address configured by setup (default to `http://localhost:8000`).
+So, to retrieve it point your browser to the socket address configured by setup (default to `http://localhost:8000`).
 
 You can get the list of accepted arguments typing:
 
@@ -124,16 +180,50 @@ You can get the list of accepted arguments typing:
     python pyload-cli.py -h
 
 
+Licensing
+---------
+
+### pyLoad  ###
+
+Refer to the attached file **LICENSE.md** for the extended license.
+
+
+### Plugin  ###
+
+According to the terms of the pyLoad license, pyload's plugins must be treated as an extension of the main program.
+This means that all the plugins must be released under the same license of pyLoad (or a compatible
+one) to be included in the official repository and released with pyLoad:
+
+ * Any plugin published **without a license notice** is intend published under the pyLoad license.
+ * A different license can be used but it **must be compatible** to the pyLoad license.
+ * Any plugin published **with a incompatible license** will be rejected.
+
+ * Is recommended to put a **shorten** license notice over the top of the plugin file.
+ * Is recommended to avoid the license notice when the plugin is published under the same license of pyLoad.
+
+
+Plugin policy
+-------------
+
+...
+
+
+Credits
+-------
+
+Refer to the attached file **CREDITS.md** for the extended credits.
+
+
 Notes
 -----
 
-For news, downloads, wiki, forum and further information visit <http://pyload.org/>.
+For news, wiki, forum and further info visit: <http://pyload.org/>.
 
-To report bugs, suggest features, ask a question, get the developer version
-or help us out, visit <https://github.com/pyload/pyload>.
+To report bugs, suggest features, ask a question or help us out, visit: <https://github.com/pyload/pyload/issues>.
+To request merging of an your patch or feature code, visit: <https://github.com/pyload/pyload/pr>.
 
 Documentation about extending pyLoad can be found at <http://docs.pyload.org> or joining us at `#pyload` on `irc.freenode.net`.
 
 
-------------------------------
-###### pyLoad Team 2008-2014 ######
+-----------------------------------
+###### pyLoad Team 2008-2015 ######
diff --git a/docs/build_docs.py b/docs/build_docs.py
index e7d656b73..3287fce8d 100644
--- a/docs/build_docs.py
+++ b/docs/build_docs.py
@@ -53,7 +53,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'pyLoad'
-copyright = u'2008-2014, pyLoad Team'
+copyright = u'2008-2015, pyLoad Team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
diff --git a/locale/README.md b/locale/README.md
deleted file mode 100644
index 2751611f7..000000000
--- a/locale/README.md
+++ /dev/null
@@ -1,55 +0,0 @@
-# Localization [![Crowdin](http://translate.pyload.org/badges/pyload/localized.png)](http://translate.pyload.org/project/pyload)
-
-The localization process take place on Crowdin:
-
-http://translate.pyload.org
-
-or
-
-http://crowdin.net/project/pyload
-
-## Add a tip for translators
-If you want to explain a translatable string to make the translation process easier you can do that using comment block starting with `L10N:`. For example:
-
-```python
-# L10N: Here the tip for translators
-# Thanks
-print _("A translatable string")
-```
-
-Translators will see:
-
-```
-L10N: Here the tip for translators
-Thanks
-```
-
-## Updating templates
-
-To update POT files run:
-
-`paver generate_locale`
-
-to automatically upload the updated POTs on Crowdin for the localization process just run:
-
-`paver upload_translations -k [api_key]`
-
-the API Key can be retrieved in the Settings panel of the project on Crowdin. This is allowed only to administrators.
-
-## Retrieve updated PO files
-
-Updated PO files can be automatically download from Crowdin using:
-
-`paver download_translations -k [api_key]`
-
-This is allowed only to administrators, users can download the last version of the translations using the Crowdin web interface.
-
-## Compile PO files
-
-MO files can be generated using:
-
-`paver compile_translations`
-
-To compile a single file just use `msgfmt`. For example to compile a core.po file run:
-
-`msgfmt -o core.mo core.po`
diff --git a/pyload/Core.py b/pyload/Core.py
index 4d07bfe0f..957f6144d 100644
--- a/pyload/Core.py
+++ b/pyload/Core.py
@@ -125,7 +125,7 @@ class Core(object):
 
     def print_help(self):
         print
-        print "pyLoad v%s     2008-2014 the pyLoad Team" % CURRENT_VERSION
+        print "pyLoad v%s     2008-2015 the pyLoad Team" % CURRENT_VERSION
         print
         if sys.argv[0].endswith(".py"):
             print "Usage: python pyload.py [options]"
diff --git a/pyload/cli/Cli.py b/pyload/cli/Cli.py
index 1ae57c290..294d8f25a 100644
--- a/pyload/cli/Cli.py
+++ b/pyload/cli/Cli.py
@@ -377,7 +377,7 @@ class RefreshThread(Thread):
 
 def print_help(config):
     print
-    print "pyLoad CLI Copyright (c) 2008-2014 the pyLoad Team"
+    print "pyLoad CLI Copyright (c) 2008-2015 the pyLoad Team"
     print
     print "Usage: [python] pyload-cli.py [options] [command]"
     print
diff --git a/pyload/config/Setup.py b/pyload/config/Setup.py
index b8d22c9ad..88e428f93 100644
--- a/pyload/config/Setup.py
+++ b/pyload/config/Setup.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# @author: vuolter
 
 import __builtin__
 
diff --git a/pyload/network/JsEngine.py b/pyload/network/JsEngine.py
index dfee29530..2e98fa37d 100644
--- a/pyload/network/JsEngine.py
+++ b/pyload/network/JsEngine.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# @author: vuolter
 
 import subprocess
 import sys
diff --git a/pyload/plugins/README.md b/pyload/plugins/README.md
deleted file mode 100644
index fa2a4c5b2..000000000
--- a/pyload/plugins/README.md
+++ /dev/null
@@ -1,16 +0,0 @@
-Licensing
----------
-
-According to the terms of the GNU General Public License,
-pyload's plugins must be treated as an extension of the main program.
-This means the plugins must be released under the GPL or a GPL-compatible
-free software license, and that the terms of the GPL must be followed when
-those plugins are distributed.
-
- * Any plugin published **without a license notice** is intend published under the **GNU GPLv3**.
- * A different license can be used but it **must be GPL-compatible** and the license notice must be put in the plugin
-   file.
- * Any plugin published **with a GPL incompatible license** will be rejected.
-   This includes *copyright all right reserved*.
- * Is recommended to put the license notice at the top of the plugin file.
- * Is recommended to **not** put the license notice when plugin is published under the GNU GPLv3.
diff --git a/pyload/utils/__init__.py b/pyload/utils/__init__.py
index a4e98ac5c..330ee622c 100644
--- a/pyload/utils/__init__.py
+++ b/pyload/utils/__init__.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# @author: vuolter
 
 """ Store all useful functions here """
 
diff --git a/pyload/utils/printer.py b/pyload/utils/printer.py
index 488f42d4a..5d333e238 100644
--- a/pyload/utils/printer.py
+++ b/pyload/utils/printer.py
@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+# @author: vuolter
 
 import colorama
 
diff --git a/pyload/webui/__init__.py b/pyload/webui/__init__.py
index 4f06d160e..964be4d3d 100644
--- a/pyload/webui/__init__.py
+++ b/pyload/webui/__init__.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# @author: RaNaN
+# @author: RaNaN, vuolter
 
 import sys
 import pyload.utils.pylgettext as gettext
diff --git a/pyload/webui/themes/bright/tml/base.html b/pyload/webui/themes/bright/tml/base.html
index 274dbe82c..9e54fc179 100644
--- a/pyload/webui/themes/bright/tml/base.html
+++ b/pyload/webui/themes/bright/tml/base.html
@@ -162,7 +162,7 @@
 
   <hr style="clear: both;" />
 
-<div id="foot">&copy; 2008-2014 pyLoad Team
+<div id="foot">&copy; 2008-2015 pyLoad Team
 <a href="#top" class="action top" accesskey="x"><span>{{_("Back to top")}}</span></a><br />
 <!--<div class="breadcrumbs"></div>-->
 
diff --git a/pyload/webui/themes/dark/tml/base.html b/pyload/webui/themes/dark/tml/base.html
index bafcc319d..a67401498 100644
--- a/pyload/webui/themes/dark/tml/base.html
+++ b/pyload/webui/themes/dark/tml/base.html
@@ -159,7 +159,7 @@
 
   <hr style="clear: both;" />
 
-<div id="foot">&copy; 2008-2014 pyLoad Team
+<div id="foot">&copy; 2008-2015 pyLoad Team
 <a href="#top" class="action top" accesskey="x"><span>{{_("Back to top")}}</span></a><br />
 <!--<div class="breadcrumbs"></div>-->
 
diff --git a/pyload/webui/themes/default/tml/base.html b/pyload/webui/themes/default/tml/base.html
index a8f20504f..821752d97 100644
--- a/pyload/webui/themes/default/tml/base.html
+++ b/pyload/webui/themes/default/tml/base.html
@@ -159,7 +159,7 @@
 
   <hr style="clear: both;" />
 
-<div id="foot">&copy; 2008-2014 pyLoad Team
+<div id="foot">&copy; 2008-2015 pyLoad Team
 <a href="#top" class="action top" accesskey="x"><span>{{_("Back to top")}}</span></a><br />
 <!--<div class="breadcrumbs"></div>-->
 
diff --git a/pyload/webui/themes/flat/tml/base.html b/pyload/webui/themes/flat/tml/base.html
index 015a64600..b617b4020 100644
--- a/pyload/webui/themes/flat/tml/base.html
+++ b/pyload/webui/themes/flat/tml/base.html
@@ -159,7 +159,7 @@
 
   <hr style="clear: both;" />
 
-<div id="foot">&copy; 2008-2014 pyLoad Team
+<div id="foot">&copy; 2008-2015 pyLoad Team
 <a href="#top" class="action top" accesskey="x"><span>{{_("Back to top")}}</span></a><br />
 <!--<div class="breadcrumbs"></div>-->