cosmetics in Jambase
[k8jam.git] / doc / INSTALL
blob0be295d2ad8b37742013facd8e51721c08c345ba
1 I. Compiling FT Jam:
2 --------------------
4   1. With a previous version of Jam:
5   ----------------------------------
7   The easiest way to compile Jam is to use a previous version of the
8   program. If you already have one installed on your system, simply
9   type "jam" in this directory.
11   This will create a new executable named "jam" or "jam.exe", located
12   in a new system-dependent directory, whose name can be:
14      bin.ntx86\jam.exe
15      bin.linux86\jam
16      etc..
19   1. On Unix and Cygwin:
20   ----------------------
22   FTJam supports the traditionnal Unix build & installation sequences,
23   you can simply type:
25      ./configure --prefix=<yourprefix>
26      make
27      make install
29   note that only the jam executable will be installed. No documentation
30   is provided for now...
33   2. With toolset-specific makefiles:
34   -----------------------------------
36   You can also use one of the Makefiles located in the "builds"
37   directory. Here's what you need to type on the command line,
38   depending on your system and compiler:
41   a. Windows + Visual C++:
43        set VISUALC=/install/path/to/visual/compiler
44        set JAM_TOOLSET=VISUALC
45        nmake -f builds\win32-visualc.mk
48   b. Windows + Borland C++: (be sure to use the Borland "make" tool)
50         set BORLANDC=/install/path/to/borland/compiler
51         set JAM_TOOLSET=BORLANDC
52         make -fbuilds\win32-visualc.mk
55   c. Windows + Mingw (gcc):
57         set BORLANDC=/install/path/to/borland/compiler
58         set JAM_TOOLSET=BORLANDC
59         make -f builds\win32-visualc.mk
62   WE DO NOT PROVIDE PROJECT FILES FOR ANY SPECIFIC COMPILER/TOOLSET
68   3. Without jam:
69   ---------------
71   If you don't have a jam binary installed, you can still compile the
72   program using the following method:
74     - copy the file "Makefile0" to "Makefile"
76     - edit the new "Makefile"  and adapt it to your OS. Simply uncomment the
77       lines specific to your system
79     - invoke your make tool
82   Note that the Makefile is used to build a boot-strap version of jam,
83   called "jam0". Once it is built, the "jam0" executable is called to
84   re-build itself.
86   If this second pass doesn't work, this is probably because you didn't
87   set some environment variable that indicates which compiler to use to
88   Jam. Read the Jam documentation for more information on this..
93 II. Installation:
94 -----------------
96   Except for Unix, we do not provide any sophisticated
97   installation pass. Simply copy the new jam executable
98   to any directory in your current path.. and start
99   using it !!
102 III. Default files:
103 -------------------
105   All default files for Jam are compiled within the
106   executable itself.
108   There are no special configuration directory to
109   place global or user preferences. Until further
110   notice, all defaults can only be changed by using
111   command line switches and setting environment
112   variables..
115 IV. Windows and OS/2 Binary packages:
116 -------------------------------------
118   It's possible to create zip files of the binaries
119   on Windows and OS/2 system by following these simple
120   steps (you need to have the "zip" utility in your
121   path !!):
123     1. build jam
124     2. strip the jam.exe executable in bin.ntx86 when
125        possible
126     3. call "jam package"
128   you should see a file named "ftjam-xxxxx-win32.zip"
129   or "ftjam-xxxxx-os2.zip" in the current directory,
130   as well as "ftjam-xxxxx.zip" (containing the sources)
133 Good luck,
136 - David Turner,  28 Jul 2001