Installation Instructions for Pybik 1.0
=======================================

If Pybik is available for your distribution, you should install Pybik with a
package manager. Otherwise see the following installation instructions.


Installation from Ubuntu PPA
============================

For Ubuntu the latest release is available in the Pybik Personal Package Archive (PPA)
<https://launchpad.net/~barcc/+archive/pybik>. Add `ppa:barcc/pybik` to your system's
software sources (with the Ubuntu Software-Center).
You can also do this in a terminal:
        sudo add-apt-repository ppa:barcc/pybik
        sudo apt-get update
        sudo apt-get install pybik


Run from source archive
=======================

Please use the latest source from the official download site
<https://launchpad.net/pybik/+download>.

Requirements
------------

Please make sure you satisfy Pybik's dependencies:
 * Python 2.7
 * Qt4 and Python bindings for Qt4 (PySide)
   You need at least the thee modules
   * qtcore, qtgui and qtopengl
 * Python bindings for OpenGL (pyopengl)
 * python-numpy
For building the extension modules [1]:
 * C-compiler (gcc)
 * development files for python
 * mesa development files
 * gettext
 * intltool
 * cython (>= 0.14.1)
 * pyside-tools
 * help2man

[1] Without the extension modules Pybik runs with poor performance.

Build
-----

Extract the archive, switch to the created directory in a terminal and enter:
        ./build_local.sh

To run Pybik you can use the command in the same directory
        ./pybik


System-wide installation
========================

This installation method is intended primarily for packagers. Pybik comes
with a full featured `setup.py` installation script. To find out more, run:
        ./setup.py --help


VCS and Daily Builds
====================

Development happens with the Bazaar version control system.
Location: <https://code.launchpad.net/~barcc/pybik/trunk>
You can get the latest revision with:
        bzr branch lp:pybik

Daily build for Ubuntu are provided in the PPA `ppa:barcc/daily-build`
<https://code.launchpad.net/~barcc/+archive/daily-build>


