$Id: README,v 1.7 2005/08/18 16:20:50 band Exp $ Authors: William L. Anderson, <band@acm.org>

Martin J. McGowan, III, <mcgowan@alum.mit.edu>

Functionality

The mknew package consists of a library of shell functions (mklib) and a shell script (mk) that provide make functionality to a standard Unix-like shell such as bash.

Install

The mknew package is delivered as a tar archive. To install mknew copy the tar file to an empty directory and extract the contents.

$ tar xvf mknew.tar

This extracts six files.

README: this file.

mklib is the library of make functions.

mklib.1 is the manpage source for mklib.

mkd is the mklib description file that specifies source files. It is what is called the "makefile" in the make utility.

mk is a script that uses mklib and mkd and carries out the specified actions.

tmk is a install script to use when installing mklib and mk for the first time. To install mklib and mk in the $HOME/bin directory simply enter

$ ./tmk all

The mkd file specifies the output directory tree by invoking the bitmeld function. bitmeld is run whenever tmk or mk are invoked; any needed directories are created during the first invocation.

Once installed mk and mklib should be available from any directory, provided that $HOME/bin is in the search path.

Use

Once installed, mklib can be used to build and install other programs and files. In a directory containing primary source files create a mkd file that specifies the primary ingredient files. To build and install these files using mklib simply type

$ mk all

$ mk # produces a help message by default

Limitations

This version of mknew only supports scripts such as shell programs, Perl programs (Ruby should work also), text files destined for a doc directory, files headed for an etc or lib directory and manpages.