Update README and related

1 files changed, 132 insertions, 42 deletions

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 ######