README

   1
   2 Gazelle: a system for building fast, reusable parsers
   3
   4 <http://www.reverberate.org/gazelle/>
   5
   6 PRELIMINARY WARNING
   7 ===================
   8
   9 This is experimental, immature software.  A few things work, but a lot of
  10 things don't.  And everything is subject to change: the APIs, the grammar
  11 language, everything.
  12
  13 Still with me?  Great. :)
  14
  15 BUILDING
  16 ========
  17
  18 You need to have Lua installed to do anything interesting.  The C runtime
  19 doesn't need Lua, but without Lua you can't compile any grammars.
  20
  21 Gazelle should build out-of-the-box on UNIX-like systems if Lua 5.1 is
  22 installed.  Ubuntu Linux and Mac OS X are tested.  Just type make:
  23
  24 $ make
  25
  26 To build the documentation, you need to have asciidoc installed, as well
  27 as graphviz if you want to see the graphics.
  28
  29 $ make doc
  30
  31 Alternatively you can just read the manual on the Gazelle website.
  32
  33 ROADMAP OF THE SOURCE
  34 =====================
  35
  36 compiler/
  37   what parses the grammar, turns it into state machines, and dumps into bytcode
  38 compiler/bootstrap
  39   compiler code that will not be needed once Gazelle is self-hosting
  40 lang_ext/
  41   wrappers around the C runtime, for high-level languages (currently only Lua)
  42 runtime/
  43   the tiny, fast, small-memory-footprint C runtime that actually does the parsing
  44 sketches/
  45   code that is either half-written or for debugging-only
  46 tests/
  47   unit tests (not very many at the moment)
  48 utilities/
  49   command-line utilities for doing useful things
  50
  51 CONTACT
  52 =======
  53
  54 For questions, comments, etc. please post to the gazelle-users group.  I read
  55 and respond to posts on this list.
  56 http://groups.google.com/group/gazelle-users
  57
  58 If you need to contact me directly, I am:
  59 Joshua Haberman <joshua@reverberate.org>
  60