-----------------------------------------------------------------------
Pre Make Kit README file

Document revision:
$Id: README 1487 2005-10-08 13:33:07Z mipsator $
-----------------------------------------------------------------------


Introduction
------------

The Pre Make Kit project is a toolkit providing a collection of tools
aimed to ease a lot of stages in project development. It provides a
scanner that generate template source components such as configuration
file or makefile. It also provides a dependency checker that sets up
templates files depending on the system components (such as auto* tools
or similar projects). For portability purpose, a BSD like install
program is also part of the kit.

The project aims the following goals :
- opensource (BSD licensed)
- portability (ISO C, POSIX, compatibility layer)
- speed and memory lighweight (compiled C binaries)
- security (replace scripts by data files, priviledge separation)
- simplicity of use (generation tools, few basic instructions)
- dependency low cost (only needs a POSIX shell and a C compiler)

The provided tools are:
- pmksetup: static data gathering tool
- pmk: dependency checker
- pmkscan: source scanner and build file generator
- pmkinstall: BSD like install program
- pmkpc: pkg-config compatible tool


1) Installation Steps
---------------------

  See the INSTALL file.


2) Testing
----------

  We provide basic tests to have some pragmatic examples of how to use
  PMK. It is also a good method to test the whole kit. You're invited to
  look in the samples directory and check the README.sample file.


3) Supported Platforms
----------------------

  Any POSIX compliant platform _should_be_ supported. We provide in the
  package a list of platform on which PMK has been compiled and tested
  (see STATUS file). You can also consult the BUGS file to see if your
  platform has specific problems that avoid PMK to run.