README

Author:Morten Lied Johansen
Contact:mortenjo@ifi.uio.no
Date:$Date: 2005-02-22 20:40:24 +0100 (Tue, 22 Feb 2005) $

This is PyMek, a make-like tool for building software projects.

The latest version can be found at http://ibidem.homeip.net/PyMek

The files included in this distribution are:

README.txt
This file.
LICENSE.rst
The license for this software
setup.py
Distutils setupscript.
scripts/pymek.py
PyMek itself.

PyMek contains the following packages and modules:

PyMek/__init__.py
PyMek package.
PyMek/config.py
Configuration module.
PyMek/log.py
Logging module.
PyMek/exceptions.py
Exceptions module.
PyMek/build.py
Build module, deals with actual building.
PyMek/parser.py
Parser module, deals with parsing PyMekfiles.
PyMek/tasks/__init__.py
Tasks package, provides baseclass and support.
PyMek/tasks/pymek_tasks.py
Contains the default set of tasks.

In addition, the following files are distributed as part of PyMek:

doc/pymekfile.xsd
XML Schema describing the PyMekfile format.
doc/tutorial.rst
Tutorial on using PyMek, in reStructuredText format.
doc/reference.rst
More detailed reference for PyMek and the tasks in rst format.

INSTALLATION

PyMek uses distutils, and installing PyMek is as easy as running the following from your commandline:

$ python setup.py install

Depending on your wishes, you may run setup.py with some options, use --help to see what they are.