vix overview

Vix is a document publishing and management application that is currently in
the early stages of development. We don't have a production version available
yet, but those brave souls that are interested in playing with the development
code are welcome to do so.

Once we are ready to release the first prototype these installation
instructions will be updated to facilitate regular end-users. In any case,
feel free to contact the author if you have any questions or suggestions
(fmw@vix.io).

Installation and Setup
======================

Before you start it is recommended to create a ``virtualenv`` sandbox for Vix
to run it, so the application and its dependencies can be installed outside
of your main Python libraries directory.

This can be done like this::
    
    sudo easy_install virtualenv
    cd ~/python/ #or wherever you want to store the virtualenv
    virtualenv vix
    source vix/bin/activate #this activates the virtualenv for this session

The next step is cloning the Vix repository using Mercurial::

    hg clone http://hg.vix.io/vix/

Afterwards, the dependencies can be installed like this::

    python setup.py develop

Make a config file as follows::

    paster make-config vix config.ini

Tweak the config file as appropriate and then setup the application::

    paster setup-app config.ini

Check the Pylons documentation for more in-depth information about running
and configuring Vix, as it is written using the Pylons framework.