granicus.if.org Git - re2c/blob - README.md

   1 DESCRIPTION
   2 -----------
   3
   4 re2c is a free and open-source lexer generator for C and C++.
   5
   6 Its main goal is generating fast lexers: at least as fast as their reasonably
   7 optimized hand-coded counterparts. Instead of using traditional table-driven
   8 approach, re2c encodes the generated finite state automata directly in the form
   9 of conditional jumps and comparisons. The resulting programs are faster and
  10 often smaller than their table-driven analogues, and they are much easier to
  11 debug and understand. re2c applies quite a few optimizations in order to speed
  12 up and compress the generated code.
  13
  14 Another distinctive feature is its flexible interface: instead of assuming a
  15 fixed program template, re2c lets the programmer write most of the interface
  16 code and adapt the generated lexer to any particular environment.
  17
  18
  19 DOCUMENTATION
  20 -------------
  21
  22 Official re2c website is [re2c.org](http://re2c.org).
  23
  24
  25 DOWNLOAD
  26 --------
  27
  28 Release tarballs: https://github.com/skvadrik/re2c/releases
  29
  30 Source code:
  31
  32 ```
  33 $ git clone https://github.com/skvadrik/re2c.git
  34 $ git clone https://git.code.sf.net/p/re2c/code-git
  35 ```
  36
  37 Github is the main repo, sourceforge is a mirror and can be slightly outdated.
  38
  39
  40 BUILD
  41 -----
  42
  43 The simplest possible way to build re2c is this:
  44
  45 ```
  46 $ ./configure [--prefix=<prefix>]
  47 $ make
  48 $ make install
  49 ```
  50 See the [official documantation](http://re2c.org/install/install.html) for full details on more sophisticated build types.
  51 If you want to build from git, you will first need to generate autotools files:
  52
  53 ```
  54 $ ./autogen.sh
  55 ```
  56
  57
  58 MAILING LISTS
  59 -------------
  60
  61 - re2c-general@lists.sourceforge.net
  62 - re2c-devel@lists.sourceforge.net
  63
  64 You are welcome to ask for help or share your thoughts and ideas.
  65
  66
  67 BUGS
  68 ----
  69 Please report any bugs and send feature requests to https://github.com/skvadrik/re2c/issues.
  70
  71
  72 AUTHORS
  73 -------
  74 Re2c was originally written by Peter Bumbulis <peter@csg.uwaterloo.ca>.
  75 Since then many people contributed to the project.
  76 Current maintainers are Ulya Trofimovich <skvadrik@gmail.com> and Dan Nuffer <nuffer@users.sourceforge.net>.