Merge branch 'hotfix/docs' into develop

docs/install.rst

@@ -3,25 +3,100 @@
 Installing
 ==========
 
-Source
-------
+Arch Linux
+----------
 
-The latest stable version is available to install using `pip <http://www.pip-installer.org/>`_:
+Livestreamer is available in the `community package repository <https://www.archlinux.org/packages/community/any/livestreamer/>`_.
+
+.. code-block:: console
+
+    # pacman -S livestreamer
+
+FreeBSD
+-------
+
+Livestreamer is available in the `ports tree <http://www.freshports.org/multimedia/livestreamer>`_ and also as a `package <http://www.freshports.org/multimedia/livestreamer>`_.
+
+**Via ports**
+
+.. code-block:: console
+
+    # cd /usr/ports/multimedia/livestreamer
+    # make install clean
+
+**Via package**
+
+.. code-block:: console
+
+    # pkg install multimedia/livestreamer
+
+Gentoo Linux
+------------
+
+Livestreamer is available in the `official portage tree <https://packages.gentoo.org/package/net-misc/livestreamer>`_:
+
+.. code-block:: console
+
+    # emerge net-misc/livestreamer
+
+Mac OS X
+--------
+
+Mac OS X comes with Python and ``easy_install`` installed by default:
+
+.. code-block:: console
+
+    # easy_install livestreamer
+
+OpenBSD
+-------
+
+Livestreamer is available in the `ports tree <http://openports.se/multimedia/livestreamer>`_:
+
+.. code-block:: console
+
+    # cd /usr/ports/multimedia/livestreamer
+    # make install clean
+
+Windows
+-------
+Livestreamer is primarily developed for Unix-like operating systems where using a CLI is common. There is however a installer available for brave Windows users who don't mind using the command prompt.
+
+The installer can be `downloaded from Github <https://github.com/chrippa/livestreamer/releases>`_. It contains a precompiled version of Livestreamer that does not require you to install any of the dependencies.
+
+Development builds
+^^^^^^^^^^^^^^^^^^
+
+There are development builds available for Windows `here <http://livestreamer-builds.s3.amazonaws.com/builds.html>`_.
+
+
+Other OSs/from source
+---------------------
+
+**Stable version**
+
+The preferred way install Livestreamer is to use the Python package manager `pip <http://www.pip-installer.org/>`_:
 
 .. code-block:: console
 
     # pip install livestreamer
 
-But you can also get the development version using `Git <http://git-scm.com/>`_:
+But it is also possible to use the old way of installing Python packages via ``easy_install``:
+
+.. code-block:: console
+
+    # easy_install livestreamer
+
+**Development version**
+
+You can get the latest development version using `Git <http://git-scm.com/>`_:
 
 .. code-block:: console
 
     $ git clone git://github.com/chrippa/livestreamer.git
     $ cd livestreamer
     # python setup.py install
 
-`The Hitchhiker’s Guide to Python <http://docs.python-guide.org/>`_ has guides
-helping you install Python + pip on the most common operating systems.
 
 Dependencies
 ^^^^^^^^^^^^
@@ -39,6 +114,10 @@ These will be installed automatically by the setup script if they are missing:
 - `python-argparse <http://pypi.python.org/pypi/argparse>`_ (only needed on Python version <2.7 and <3.2)
 - `python-requests <http://docs.python-requests.org/>`_ (at least version 1.0)
 
+
+`The Hitchhiker’s Guide to Python <http://docs.python-guide.org/>`_ has guides
+helping you install Python on most common operating systems.
+
 Optional dependencies
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -54,19 +133,4 @@ For full UStream.tv support:
 
 - `python-librtmp <https://github.com/chrippa/python-librtmp>`_
 
-Distribution packages
----------------------
-
-Livestreamer is also available in these package repositories:
-
-- `Arch Linux <https://www.archlinux.org/packages/community/any/livestreamer/>`_
-- `FreeBSD <http://www.freshports.org/multimedia/livestreamer>`_
-- `Gentoo Linux <https://packages.gentoo.org/package/net-misc/livestreamer>`_
-- `OpenBSD <http://openports.se/multimedia/livestreamer>`_
-
-Windows
-^^^^^^^
-Livestreamer is primarily developed for Unix-like operating systems where using a CLI is common. There is however a installer available for brave Windows users who don't mind using the command prompt.
-
-The installer can be `downloaded from Github <https://github.com/chrippa/livestreamer/releases>`_. It contains a precompiled version of Livestreamer that does not require you to install any of the dependencies.
 

docs/issues.rst

@@ -39,3 +39,17 @@ MPC-HC reports "File not found"
 Upgrading to version 1.7 or newer will solve this issue since reading data
 from standard input is not supported in version 1.6.x of MPC-HC.
 
+
+MPC-HC only plays sound on Twitch streams
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Twitch sometimes returns badly muxed streams which may confuse players. The
+following workaround was contributed by MPC-HC developer `kasper93 <https://github.com/kasper93>`_:
+
+*To fix this problem go to options -> internal filters -> open splitter settings
+and increase "Stream Analysis Duration" this will let ffmpeg to properly detect
+all streams.*
+
+Using ``--player-passthrough hls`` has also been reported to work.
+
+