Readme improvements

.gitignore

@@ -40,9 +40,13 @@ nosetests.xml
 .pydevproject
 
 # Temp files
-
 *~
 
 # Pipy codes
-
 .pypirc
+
+# Mac
+.DS_Store
+
+# JetBrains
+.idea

README.rst

@@ -1,7 +1,14 @@
 MoviePy
-========
+=======
 
-MoviePy (full documentation here_) is a Python module for video editing: cuts, concatenations, title insertions, video compositing (a.k.a. non-linear editing), video processing, and creation of custom effects. See the gallery_ for some examples of use.
+.. image:: https://badge.fury.io/py/moviepy.svg
+    :target: PyPI_
+    :alt: MoviePy page on the Python Package Index
+.. image:: https://badges.gitter.im/movie-py/gitter.png
+    :target: Gitter_
+    :alt: Discuss MoviePy on Gitter
+
+MoviePy (full documentation_) is a Python module for video editing: cutting, concatenations, title insertions, video compositing (a.k.a. non-linear editing), video processing, and creation of custom effects. See the gallery_ for some examples of use.
 
 MoviePy can read and write all the most common audio and video formats, including GIF, and runs on Windows/Mac/Linux, with Python 2.7+ and 3. Here it is in action in an IPython notebook:
 
@@ -10,7 +17,7 @@ MoviePy can read and write all the most common audio and video formats, includin
     :align: center
 
 Example
---------
+-------
 
 In this example we open a video file, select the subclip between t=50s and t=60s, add a title at the center of the screen, and write the result to a new file:
 
@@ -29,77 +36,91 @@ In this example we open a video file, select the subclip between t=50s and t=60s
     result.write_videofile("myHolidays_edited.webm",fps=25) # Many options...
 
 
+Installation
+------------
 
-Contribute !
--------------
+MoviePy depends on the Python modules Numpy_, imageio_, Decorator_, and tqdm_, which will be automatically installed during MoviePy's installation. The software FFMPEG should be automatically downloaded/installed (by imageio) during your first use of MoviePy (installation will take a few seconds). If you want to use a specific version of FFMPEG, follow the instructions in ``config_defaults.py``. In case of trouble, provide feedback.
 
-MoviePy is an open-source software originally written by Zulko_ and released under the MIT licence. The project is hosted on Github_ , where everyone is welcome to contribute, ask for help or simply give feedback.
+**Installation by hand:** download the sources, either from PyPI_ or, if you want the development version, from Github_, unzip everything into one folder, open a terminal and type: ::
 
-You can also discuss about the project on Reddit_ or on the mailing list moviepy@librelist.com .
+    $ (sudo) python setup.py install
 
+**Installation with pip:** if you have ``pip`` installed, just type this in a terminal: ::
 
-Maintainers
---------------
+    $ (sudo) pip install moviepy
 
-- Zulko_ - Owner
-- mbeacom_
+If you have neither ``setuptools`` nor ``ez_setup`` installed, the command above will fail. In this case type this before installing: ::
 
+    $ (sudo) pip install ez_setup
 
-Installation
----------------
 
-MoviePy depends on the Python modules Numpy_, imageio_, Decorator_, and tqdm_, which will be automatically installed during MoviePy's installation. The software FFMPEG should be automatically downloaded/installed (by imageio) during your first use of MoviePy (it takes a few seconds). If you want to use a specific version of FFMPEG, follow the instructions in file ``config_defaults.py``. In case of trouble, provide feedback.
+Optional but useful dependencies
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-**Installation by hand:** download the sources, either on PyPI_ or (if you want the development version) on Github_, unzip everything in one folder, open a terminal and type ::
+ImageMagick_ is not strictly required, but needed if you want to incorporate texts. It can also be used as a backend for GIFs, though you can also create GIFs with MoviePy without ImageMagick.
 
-    (sudo) python setup.py install
+Once you have installed ImageMagick, it will be automatically detected by MoviePy, **except on Windows!**. Windows users, before installing MoviePy by hand, need to edit ``moviepy/config_defaults.py`` to provide the path to the ImageMagick binary, which is called `convert`. It should look like this ::
 
-**Installation with pip:** if you have ``pip`` installed, just type this in a terminal: ::
+    IMAGEMAGICK_BINARY = "C:\\Program Files\\ImageMagick_VERSION\\convert.exe"
 
-    (sudo) pip install moviepy
+PyGame_ is needed for video and sound previews (not relevant if you intend to work with MoviePy on a server but essential for advanced video editing by hand).
 
-If you have neither ``setuptools`` nor ``ez_setup`` installed the command above will fail, is this case type this before installing: ::
+For advanced image processing, you will need one or several of the following packages:
 
-    (sudo) pip install ez_setup
+- The Python Imaging Library (PIL) or, even better, its branch Pillow_.
+- Scipy_ (for tracking, segmenting, etc.) can be used to resize video clips if PIL and OpenCV are not installed.
+- `Scikit Image`_ may be needed for some advanced image manipulation.
+- `OpenCV 2.4.6`_ or a more recent version (one that provides the package ``cv2``) may be needed for some advanced image manipulation.
 
+For instance, using the method ``clip.resize`` requires that at least one of Scipy, PIL, Pillow or OpenCV is installed.
 
-Other optional but useful dependencies
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-ImageMagick_ is not strictly required, only if you want to write texts. It can also be used as a backend for GIFs but you can do GIFs with MoviePy without ImageMagick.
+Contribute
+----------
 
-Once you have installed it, ImageMagick will be automatically detected by MoviePy, **except on Windows !**. Windows user, before installing MoviePy by hand, go into the ``moviepy/config_defaults.py`` file and provide the path to the ImageMagick binary called `convert`. It should look like this ::
+MoviePy is open-source software originally written by Zulko_ and released under the MIT licence. The project is hosted on Github_, where everyone is welcome to contribute, ask for help or simply give feedback.
 
-    IMAGEMAGICK_BINARY = "C:\\Program Files\\ImageMagick_VERSION\\convert.exe"
+You can also discuss the project on Reddit_ (preferred over GitHub issues for usage/examples), Gitter_ or the mailing list moviepy@librelist.com.
 
-PyGame_ is needed for video and sound previews (useless if you intend to work with MoviePy on a server but really essential for advanced video editing *by hand*).
 
-For advanced image processing you will need one or several of these packages. For instance using the method ``clip.resize`` requires that at least one of Scipy, PIL, Pillow or OpenCV are installed.
+Maintainers
+-----------
 
-- The Python Imaging Library (PIL) or, better, its branch Pillow_ .
-- Scipy_ (for tracking, segmenting, etc.), and can be used for resizing video clips if PIL and OpenCV aren't installed on your computer.
-- `Scikit Image`_ may be needed for some advanced image manipulation.
-- `OpenCV 2.4.6`_ or more recent (which provides the package ``cv2``) may be needed for some advanced image manipulation.
+- Zulko_ (owner)
 
+- `@Gloin1313`_
+- `@earney`_
+- Kay `@kerstin`_
+- `@mbeacom`_
 
+
+.. MoviePy links
 .. _gallery: http://zulko.github.io/moviepy/gallery.html
+.. _documentation: http://zulko.github.io/moviepy/
+.. _`download MoviePy`: https://github.com/Zulko/moviepy
+
+.. Websites, Platforms
 .. _Reddit: http://www.reddit.com/r/moviepy/
 .. _PyPI: https://pypi.python.org/pypi/moviepy
-.. _Pillow: http://pillow.readthedocs.org/en/latest/
-.. _Zulko : https://github.com/Zulko
-.. _mbeacom : https://github.com/mbeacom
 .. _Github: https://github.com/Zulko/moviepy
-.. _here: http://zulko.github.io/moviepy/
+.. _Gitter: https://gitter.im/movie-py/Lobby
+
+.. Software, Tools, Libraries
+.. _Pillow: http://pillow.readthedocs.org/en/latest/
 .. _Scipy: http://www.scipy.org/
-.. _`download MoviePy`: https://github.com/Zulko/moviepy
 .. _`OpenCV 2.4.6`: http://sourceforge.net/projects/opencvlibrary/files/
 .. _Pygame: http://www.pygame.org/download.shtml
 .. _Numpy: http://www.scipy.org/install.html
 .. _imageio: http://imageio.github.io/
 .. _`Scikit Image`: http://scikit-image.org/download.html
 .. _Decorator: https://pypi.python.org/pypi/decorator
 .. _tqdm: https://github.com/noamraph/tqdm
-
-
 .. _ffmpeg: http://www.ffmpeg.org/download.html
 .. _ImageMagick: http://www.imagemagick.org/script/index.php
+
+.. People
+.. _Zulko: https://github.com/Zulko
+.. _`@Gloin1313`: https://github.com/Gloin1313
+.. _`@earney`: https://github.com/earney
+.. _`@kerstin`: https://github.com/kerstin
+.. _`@mbeacom`: https://github.com/mbeacom