From bcb925691cc4cfc9309ba6ba7bd192de7ce9c781 Mon Sep 17 00:00:00 2001
From: Siddharth Ravikumar <sravik@bgsu.edu>
Date: Thu, 24 Dec 2015 19:25:55 -0500
Subject: Added docs/setup/index.rst

`docs/setup/index.rst` contains information about install combox on
gnu/linux and osx and information about setting up development
environment on windows.
---
 docs/setup/index.rst | 165 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 165 insertions(+)
 create mode 100644 docs/setup/index.rst

(limited to 'docs')

diff --git a/docs/setup/index.rst b/docs/setup/index.rst
new file mode 100644
index 0000000..50d9513
--- /dev/null
+++ b/docs/setup/index.rst
@@ -0,0 +1,165 @@
+=====
+setup
+=====
+
+.. highlight:: bash
+
+gnu/linux
+=========
+
+Install ``python-pip`` package.
+
+On Debian_ or Ubuntu_::
+
+  $ sudo aptitude install python-pip
+
+On Fedora_::
+
+  $ sudo yum install python-pip
+
+On Arch_::
+
+  $ pacman -S python2-pip
+
+.. _Debian: https://www.debian.org
+.. _Ubuntu: http://www.ubuntu.com
+.. _Fedora: https://getfedora.org
+.. _Arch: https://www.archlinux.org
+
+Install ``combox`` using the ``pip`` installer::
+
+  $ pip install combox
+
+
+os x
+====
+
+If Hombrew_ is not already installed, install it first::
+
+    $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+
+.. _Hombrew:  http://brew.sh/
+
+Next, install ``python`` from Hombrew_::
+
+  $ brew install python
+
+This will also install ``pip``.
+
+Install ``combox`` using the ``pip`` installer::
+
+  $ pip install combox
+
+
+windows
+=======
+
+.. highlight:: powershell
+
+At the moment, ``combox`` is not compatible with Windows. The following
+sections describe how to set up the development environment on
+Windows.
+
+
+setup python, pip and virtualenv
+--------------------------------
+
+Install python v2.7.x first: `python.org/downloads/windows`__
+
+.. _pywindows: https://www.python.org/downloads/windows
+.. __: pywindows_
+
+Add python to ``PATH``:
+
+.. code-block:: none
+
+   %PATH%;C:\Python27
+
+Make sure python works from Windows Powershell
+
+Get a copy of `get-pip.py`_.
+
+.. _get-pip.py: https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py
+
+From Windows Powershell, ``cd`` to the directory containing
+``get-pip.py`` file and do::
+
+  python get-pip.y
+
+That should install ``pip`` and ``setuptools``.
+
+Next, add pip to ``PATH``:
+
+.. code-block:: none
+
+    %PATH%;C:\Python27;C:\Python27\Scripts
+
+Make sure ``pip`` works from Windows Powershell by doing::
+
+  pip --version
+
+Lastly, install ``virtualenv``::
+
+  pip install virtualenv
+
+
+install git
+-----------
+
+Get a copy of ``git`` from `git-scm.com/download/win`__
+
+.. _gitwin: http://git-scm.com/download/win
+.. __: gitwin_
+
+In the "Adjusting your PATH environment" screen in the ``git``
+installation wizard, choose the "Use Git from the Windows Command
+Prompt"
+
+Make sure ``git`` works from Windows Powershell by doing::
+
+  git --version
+
+
+setup combox
+------------
+
+install v. c++ compiler
+_______________________
+
+From `aka.ms/vcpython27`__ (this is required for installing
+``pycrypto`` package from ``pip``).
+
+.. _vcpython27: http://aka.ms/vcpython27
+.. __: vcpython27_
+
+
+setup combox
+____________
+
+From the Windows Powershell, do::
+
+  git clone git://ricketyspace.net/combox.git
+
+
+setup virtual environment
+.........................
+
+``cd`` to the ``combox`` directory and do::
+
+  virtualenv .
+
+
+activate virtual environment
+............................
+
+``cd`` to the ``combox`` directory and do::
+
+  .\Scripts\activate
+
+
+install combox
+..............
+
+in ``develop`` mode::
+
+  python setup.py develop
-- 
cgit v1.2.3