trunk/jam/ReadMe.txt


BUILDING ASCEND with JAM
------------------------

The files in this directory support building the Ascend
libraries and executables using the jam* build tool.

The following files are included:

  Jamrules_general.in - configuration & custom build rules used 
                        by Jamfiles
  Jambase             - lightly customized version of standard 
                        build rules (primarily to shore up support
                        for different compilers)

The Ascend jam build system currently supports building under Windows 
using the MSVC, Borland, MinGW, and Watcom** compilers, and under
Linux using gcc/g77.  With use of the included Jambase file, it should 
work with both the original and ftjam variants of jam. However, the
system was developed primarily using ftjam.

Automatic processing of Jamrules_general.in to Jamrules_general by
configure is not currently implemented.  A skeleton script
'configure' is provided which will copy the 'Jamrules_general.in' file
to 'Jamrules_general'. This file then needs to be hand-editied for
your local preferences and configuration.


Build Instructions - Linux
--------------------------

You can build the Jam static libraries on Linux at present:

1. jam must be installed and configured for the compiler in use.

2. Run ./configure 
   See above comments -- this script is just a skeleton at the moment

3. Manually edit Jamrules_general to set configuration and local
   directory options.  These settings are used by all the Jamfiles
   in the Ascend source tree.

4. Change directory to base/generic/jam, type 'jam libs'

The static libraries will end up in base/generic/jam/Release/linux

Build Instructions - Windows
----------------------------

As above, but instead of steam (2.) you need to manualy copy the
Jamrules_general.in file to Jamrules_general.


Notes
-----

* jam is an open source, multi-platform build tool
  which is available in several flavors.  These include
  the original (http://www.perforce.com) and ftjam
  (http://www.freetype.org/jam/index.html) variants,
  among others.

** Currently, Open Watcom 1.3 can compile the Ascend sources
  and build the libraries.  However, it does not supply the required
  IEEE math functions isnan() and copysign().  At present, Ascend does
  not supply these, so the user must provide these functions to use
  the libraries under Watcom.

Updated Dec 6 2005 -- johnpye
1	johnpye	79
2			BUILDING ASCEND with JAM
3			------------------------
4
5	jds	40	The files in this directory support building the Ascend
6			libraries and executables using the jam* build tool.
7
8			The following files are included:
9
10	johnpye	79	Jamrules_general.in - configuration & custom build rules used
11			by Jamfiles
12			Jambase - lightly customized version of standard
13			build rules (primarily to shore up support
14			for different compilers)
15	jds	40
16			The Ascend jam build system currently supports building under Windows
17			using the MSVC, Borland, MinGW, and Watcom** compilers, and under
18			Linux using gcc/g77. With use of the included Jambase file, it should
19	jds	47	work with both the original and ftjam variants of jam. However, the
20			system was developed primarily using ftjam.
21	jds	40
22	jds	47	Automatic processing of Jamrules_general.in to Jamrules_general by
23	johnpye	79	configure is not currently implemented. A skeleton script
24			'configure' is provided which will copy the 'Jamrules_general.in' file
25			to 'Jamrules_general'. This file then needs to be hand-editied for
26			your local preferences and configuration.
27	jds	40
28
29	johnpye	79	Build Instructions - Linux
30			--------------------------
31
32			You can build the Jam static libraries on Linux at present:
33	jds	40
34			1. jam must be installed and configured for the compiler in use.
35
36	johnpye	79	2. Run ./configure
37			See above comments -- this script is just a skeleton at the moment
38	jds	40
39	jds	47	3. Manually edit Jamrules_general to set configuration and local
40	jds	40	directory options. These settings are used by all the Jamfiles
41			in the Ascend source tree.
42
43	johnpye	79	4. Change directory to base/generic/jam, type 'jam libs'
44
45			The static libraries will end up in base/generic/jam/Release/linux
46
47			Build Instructions - Windows
48			----------------------------
49
50			As above, but instead of steam (2.) you need to manualy copy the
51			Jamrules_general.in file to Jamrules_general.
52
53	jds	40
54	johnpye	79	Notes
55			-----
56	jds	40
57			* jam is an open source, multi-platform build tool
58	johnpye	79	which is available in several flavors. These include
59			the original (http://www.perforce.com) and ftjam
60			(http://www.freetype.org/jam/index.html) variants,
61			among others.
62	jds	40
63			** Currently, Open Watcom 1.3 can compile the Ascend sources
64	johnpye	79	and build the libraries. However, it does not supply the required
65			IEEE math functions isnan() and copysign(). At present, Ascend does
66			not supply these, so the user must provide these functions to use
67			the libraries under Watcom.
68	jds	40
69	johnpye	79	Updated Dec 6 2005 -- johnpye