INSTALL: Installation instructions for 'objmk'

If you intend to build this software using a BSD system, read the INSTALL.BSD
file, as well. 

NOTE: If you haven't already, it's STRONGLY RECOMMENDED to peruse the included
      README file first.

===========================================

Table -of- Contents

A. Basic installation instructions
	1) Configuration
	2) Building
	3) Installation
	4) Cleaning
	5) Uninstallation/Deinstallation

B. Extended configuration
	1) The 'user.mk' file
	2) The environment 
	3) A note on 'Makefile' readability 

C. Signoff

===========================================

A. Basic installation instructions

	1) Configuration: Set the INSTDIR environment variable to alter the
	   destination directory; the default is '/usr/pkg', which may or may
	   not be appropriate for your system. More clasically, the PREFIX
	   environment variable may also be used; however, beware that this may
	   may evoke side-effects, such as using headers or libraries from a 
	   different location than desired.

	   Set the ZSH environment variable to the 'zsh' interpreter
	   executable; the default is '/usr/pkg/bin/zsh', which may or may not
	   be appropriate for your system. When using the 'user.mk' file, it is
	   RECOMMENDED to use the INTERPRETER.zsh makefile variable instead.
	   See section B, directive 1, "The 'user.mk' file" for more
	   information on the 'user.mk' file.

	2) Building: 'make all' to build the software.

	3) Installation: 'make install' to install the software to its
	   (hopefully desired :^) destination.

	4) Cleaning (optional): 'make clean' to remove any and all output files
	   generated by the build process.

	5) Uninstallation/Deinstallation (I hope not :^): 'make uninstall' or
	   'make deinstall' to remove the software from the system. Please
	   remember to re-set (/not/ 'reset') the INSTDIR and/or PREFIX
	   variables, if they were originally used during the build process.

===========================================

B. Extended configuration

	1) The 'user.mk' file: may be used to override certain build parameters.
	   Modify it, then define the USE_USER_MK environment variable to make
	   the modifications effective. Remove the USE_USER_MK variable from the
	   environment to restore normal operation. This is best suited to
	   extensive modifications; of this, inclusion in a package system is an
	   example. For more casual modifications, use of the environment (see
	   below) is RECOMMENDED.

	2) The environment: Several build parameters can be overridden in the
	   environment. See env(7) for more information about the environment.

	3) A note on 'Makefile' readability: The 'Makefile' used in this
	   distribution should be simple enough to understand, even for casual
	   operators/administrators. This allows the author to omit
	   documentation about most build parameters :) 

===========================================

C. Signoff

The end... for now!

--De Zeurkous.

[Last modified at Tue Feb 26 03:51:13 UTC 2008 by De Zeurkous.]
[(C) Erik ``De Zeurkous'' Bogeholt, 2008. All rights reserved.]
[May be used, distributed, and modified freely, as long as my ]
[name is removed from the signoff and credit is given where it]
[is due.                                                      ]