From 9c9988f28a8a0efb444a63827476b16fdf3cfa10 Mon Sep 17 00:00:00 2001
From: Siddharth Ravikumar <sravik@bgsu.edu>
Date: Tue, 22 Dec 2015 15:21:13 -0500
Subject: Added docs/ (uses sphinx).

Most of what was in README.rst was moved to docs/
---
 docs/windows.rst | 114 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 114 insertions(+)
 create mode 100644 docs/windows.rst

(limited to 'docs/windows.rst')

diff --git a/docs/windows.rst b/docs/windows.rst
new file mode 100644
index 0000000..99a3cb8
--- /dev/null
+++ b/docs/windows.rst
@@ -0,0 +1,114 @@
+==========
+on 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