README

   1
   2                      Ragel State Machine Compiler -- README
   3                      ======================================
   4
   5 1. Build Requirements
   6 ---------------------
   7
   8  * GNU Make
   9  * g++
  10
  11 If you would like to modify Ragel and need to build Ragel's scanners and
  12 parsers from the specifications then set BUILD_PARSERS=true in the configure
  13 script and then run it. This variable is normally set to false in the
  14 distribution tarballs and true in version control. You will need the following
  15 programs:
  16
  17  * ragel (the most recent version)
  18  * kelbt (the most recent version)
  19
  20 To build the user guide the following extra programs are needed:
  21
  22  * fig2dev
  23  * pdflatex
  24
  25
  26 2. Compilation
  27 --------------
  28
  29 To configure type './configure'. The makefiles honour the --prefix option to
  30 specify where the program is to be installed to.
  31
  32 To build the ragel program type 'make'.
  33
  34 To build all the documentation cd to 'doc' and type 'make'. If you don't have
  35 all of the programs to build the user guide and just want the man page use
  36 'make man'.
  37
  38
  39 3. Installing
  40 -------------
  41
  42 The command 'make install' will build the programs and install them to
  43 $PREFIX/bin/.  A 'make install' in the doc directory will make and install all
  44 the documentation.  The man pages install to $PREFIX/man/man1/ and the user
  45 guide and ChangeLog install to $PREFIX/share/doc/ragel/. To install just the
  46 man page use 'make man-install'.