Permalink
Browse files

Add README.

  • Loading branch information...
1 parent bf94ec1 commit 638d6c761cc0911354af90f7835b265ebbff1a7f @seancribbs committed Jun 22, 2009
Showing with 39 additions and 0 deletions.
  1. +39 −0 README.textile
View
39 README.textile
@@ -0,0 +1,39 @@
+h1. Neotoma
+
+h2. About
+
+Neotoma is a packrat parser-generator for Erlang for Parsing Expression Grammars (PEGs).
+It consists of a parsing-combinator library with memoization routines, a parser for PEGs,
+and a utility to generate parsers from PEGs. It is inspired by treetop, a Ruby library with
+similar aims, and parsec, the parser-combinator library for Haskell.
+
+Neotoma is licensed under the MIT License (see LICENSE).
+
+h2. Features
+
+# Simple, declarative parsers generated from even simpler grammars.
+# Fully integrated, single-pass lexical and syntactic analysis (a feature of PEGs).
+# Packrat-style memoization, boasting parse-time bound linearly to the input size (at the expense of memory usage).
+# In-place semantic analysis/transformation, supporting single-pass end-to-end in some applications.
+# Erlang code-generation for the lexical/syntactic analysis piece, with the option of semantic analysis/transformation in a separate module.
+# Line/column number tracking for easy resolution of parsing errors.
+
+h2. Installation
+
+# Clone the repository from github: <notextile><pre><code>$ git clone git://github.com/seancribbs/neotoma.git</code></pre></notextile>
+# Symlink or copy the cloned repository to somewhere in your Erlang code path. $ERLANG_HOME/lib is best.
+# Build the source: <notextile><pre><code>$ rake</code></pre></notextile>
+ Building currently requires Ruby 1.8 or later and the @rake@ RubyGem.
+
+h2. Usage
+
+# After making sure the library is in your code path, fire up an Erlang shell.
+# To generate a parser from a PEG, use @peg_gen:file/1,2@ (more detailed documentation pending). For PEG examples, see the @extra/@ directory in the repository.
+
+ <notextile><pre><code>1&gt; peg_gen:file("extra/arithmetic.peg").</code></pre></notextile>
+
+ This will place @arithmetic.erl@ in the same directory as the @.peg@ file by default.
+
+h2. Contributing
+
+Please send pull-requests to 'seancribbs' on github. When submitting a patch, eunit tests are strongly encouraged.

0 comments on commit 638d6c7

Please sign in to comment.