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. To build the parsers you will need the following
  14 programs:
  15
  16  * ragel (the most recent version)
  17  * kelbt (the most recent version)
  18
  19 To build the user guide the following extra programs are needed:
  20
  21  * fig2dev
  22  * pdflatex
  23
  24
  25 2. Compilation
  26 --------------
  27
  28 To configure type './configure'. The makefiles honour the --prefix option to
  29 specify where the program is to be installed to.
  30
  31 To build the ragel program type 'make'.
  32
  33 To build all the documentation cd to 'doc' and type 'make'. If you don't have
  34 all of the programs to build the user guide and just want the man page use
  35 'make man'.
  36
  37
  38 3. Installing
  39 -------------
  40
  41 The command 'make install' will build the programs and install them to
  42 $PREFIX/bin/.  A 'make install' in the doc directory will make and install all
  43 the documentation.  The man pages install to $PREFIX/man/man1/ and the user
  44 guide and ChangeLog install to $PREFIX/share/doc/ragel/. To install just the
  45 man page use 'make man-install'.