Some quick, basic documentation.

This commit is contained in:
2013-11-07 21:12:07 +00:00
parent c800be8c34
commit 94787242f2
8 changed files with 815 additions and 1 deletions

View File

@@ -0,0 +1,33 @@
============
Installation
============
Prerequisites
=============
MumblePy has a few requirements that can't be installed easily from Pypi, depending on your platform they may take a bit of work.
* ZeroC ICE
* ZeroC ICE Python Bindings
Depending on your connection to the target Mumble server, you may need ``Glacier2`` available as well.
Ubuntu / Debian
---------------
Ubuntu has packages for ZeroC Ice in the general repository, Just install the ``python-zeroc-ice`` and ``zeroc-ice`` packages.
.. code-block:: bash
sudo apt-get install python-zeroc-ice zeroc-ice
OSX / Windows
-------------
ZeroC provide a full installation package for OSX and Windows systems on the `ZeroC Downloads`_ page.
.. _ZeroC Downloads: http://www.zeroc.com/download.html