changeset 55:ca90761a1615

Added installation guide, taken from the INSTALL file.
author Martin Geisler <mg@daimi.au.dk>
date Tue, 26 Feb 2008 22:08:28 +0100
parents ac06a6915076
children d40f574e6acc
files index.txt install.txt
diffstat 2 files changed, 118 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/index.txt	Sun Feb 24 11:41:24 2008 +0100
+++ b/index.txt	Tue Feb 26 22:08:28 2008 +0100
@@ -54,7 +54,7 @@
 
 VIFF is implemented in Python_ using Twisted_ and should run on any
 platform where Python runs (succesfully tested on Linux and Windows).
-Please see the INSTALL_ file for details on the requirements.
+Please see the `installation guide`_ for details on the requirements.
 
 VIFF is Free Software, licensed under the `GNU GPL`_. This means that
 you can download and use it for free and modify it to suit your needs.
@@ -63,7 +63,7 @@
 
 .. _Python: http://python.org/
 .. _Twisted: http://twistedmatrix.com/
-.. _INSTALL: http://hg.viff.dk/viff/raw-file/tip/INSTALL
+.. _installation guide: install.html
 .. _GNU GPL: http://hg.viff.dk/viff/raw-file/tip/COPYING
 
 Use Cases
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/install.txt	Tue Feb 26 22:08:28 2008 +0100
@@ -0,0 +1,116 @@
+.. -*- coding: utf-8 -*-
+
+====================================
+ Installation Instructions for VIFF
+====================================
+
+VIFF is written in Python and uses the Twisted framework for
+asynchronous communication, (optionally) python-gnutls for secure
+communication, ConfigObj for configuration files, and GMPY for fast
+bignum arithmetic. You can find these components here:
+
+Python:
+  http://python.org/
+Twisted:
+  http://twistedmatrix.com/
+python-gnutls:
+  http://pypi.python.org/pypi/python-gnutls/
+ConfigObj:
+  http://voidspace.org.uk/python/configobj.html
+GMPY:
+  http://code.google.com/p/gmpy/
+
+VIFF has been tested with the following versions: Python 2.4.1,
+Twisted 2.5.0, python-gnutls 1.1.4, ConfigObj 4.4.0, and GMPY
+1.0alpha. Things might work with earlier versions, we do not know yet.
+Please report back if you find that VIFF works with earlier versions
+than the ones listed here.
+
+Below you will find installation instructions for the different
+platforms on which we test VIFF.
+
+Windows
+-------
+
+(To be written…)
+
+Mac OS X
+--------
+
+(To be written…)
+
+GNU/Linux
+---------
+
+VIFF was originally developed on GNU/Linux and is well supported
+there. When installing the VIFF dependencies you either have the
+option of using your package manager or to install from source.
+
+Using a Package Manager
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Debian Lenny (unstable)
+  You can install all dependencies by the command
+
+  .. sourcecode:: sh
+
+     aptitude install python-twisted-core python-gnutls \
+                      python-configobj python-gmpy
+
+  The backslash indicates that both lines should be typed as a single
+  line in the terminal.
+
+Ubuntu
+  We expect that the instructions for Debian also apply here.
+
+
+If you know how to install using other package managers, please `let
+us know`_.
+
+.. _let us know: viff-devel@viff.dk
+
+VIFF itself is not yet packaged for any distribution, so you will have
+to install it from source as described below.
+
+
+Installing from Source
+~~~~~~~~~~~~~~~~~~~~~~
+
+If you do not have permission to use the package manager or simply
+prefer to install from source, then (assuming that Python is already
+installed) one can easily install VIFF and its dependencies by
+downloading and unpacking each of them and executing
+
+.. sourcecode:: sh
+
+   python setup.py install --home=$HOME/opt
+
+That will install everything under the given prefix. With the above
+command the Python modules are installed into
+
+.. sourcecode:: sh
+
+   $HOME/opt/lib/python
+
+and some programs are installed into
+
+.. sourcecode:: sh
+
+   $HOME/opt/bin
+
+You should add the first directory to the ``PYTHONPATH`` environment
+variable and the latter to the ``PATH`` environment variable.
+
+Bash uses can normally do this by adding
+
+.. sourcecode:: bash
+
+   export PYTHONPATH=$PYTHONPATH:$HOME/opt/lib/python
+   export PATH=$PATH:$HOME/opt/bin
+
+to their ``~/.bash_profile`` file, creating it if it is not already
+there. Consult the documentation for your shell to learn how
+environment variables are set.
+
+
+.. include:: layout.rst