doc/README

   1 =============================================================================
   2
   3 This if "FT-Jam", a simple derivative of the Jam build tool, based and
   4 100% compatible with Jam 2.5. See http://www.freetype.org/jam/ for more
   5 details.
   6
   7 This is a non-official release of FT-Jam, dubbed 2.5.1 at the moment.
   8
   9 Note that you'll find the original Jam README in the file README.ORG
  10
  11
  12
  13 Installation on Unix (and Cygwin):
  14 ----------------------------------
  15
  16 Unlike Classic Jam, this release can be installed with traditionnal Unix
  17 commands, i.e.:
  18
  19   ./configure <options>
  20   make
  21   make install    (may need to be root)
  22
  23 at the moment, only the 'jam' executable is installed in $prefix/bin.
  24 we'll try to install the documentation and convert it to manpages later,
  25 if time permits.
  26
  27 If the './configure' command doesn't work, do the following, you might
  28 have a working source release that wasn't packaged for distribution. You
  29 can get it to install normally doing the following:
  30
  31   chmod +x configure
  32   chmod +x yyacc
  33   cd builds/unix
  34   autoconf
  35   cd ../..
  36
  37 then
  38
  39   ./configure <options>
  40   make
  41   make install
  42
  43
  44 Installation on Win32:
  45 ----------------------
  46
  47 We provide a few build scripts for various compilers on Win32. In all cases,
  48 this will generate an executable named 'jam.exe' within the bin.ntx86
  49 directory:
  50
  51   Visual C++:
  52     set JAM_TOOLSET=VISUALC
  53     nmake -f builds\win32-visualc.mk
  54
  55   Borland C++:
  56     set JAM_TOOLSET=BORLANDC
  57     make -fbuilds\win32-borlandc.mk
  58
  59   Mingw:
  60     set JAM_TOOLSET=MINGW
  61     make -f builds/win32-gcc.mk
  62
  63   Digital Mars:
  64     set JAM_TOOLSET=DIGITALMARS
  65     make -f builds\win32-dmars.mk
  66
  67   Cygwin:
  68     make -f builds/win32-cygwin.mk
  69
  70
  71 Copy the executable to your path.
  72
  73 ==============================================================================
  74 IMPORTANT FOR CYGWIN AND MINGW USERS:
  75 Note that the Mingw and Cygwin builds produce different executables !!
  76 the first one will only work correctly on the Windows command line, while
  77 the second one will only work on a Unix shell (e.g. Bash).
  78 ===============================================================================
  79
  80
  81 Installation with Jam or FT-Jam:
  82 --------------------------------
  83
  84 If you already have a previous version of Jam or FT-Jam in your path, simply
  85 invoke it from the root directory. This will generate the 'jam' or 'jam.exe'
  86 executable in a directory named 'bin.<system>', where '<system>' depends
  87 on your platform, e.g.  bin.linuxx86, bin.ntx86, etc...
  88
  89
  90 Differences with Classic Jam:
  91 -----------------------------
  92
  93 Sorry, there is no official documentation at the moment. You can however
  94 parse the 'Jambase' file, since documentation comments have been added to
  95 all important rules.
  96
  97
  98 Troubleshooting:
  99 ----------------
 100
 101 Please report problems to the Jam mailing list (jamming@perforce.com).
 102 We'll try to create a FT-Jam specific list in the future.