Permalink
Browse files

Add a Readme for the project

  • Loading branch information...
1 parent 71d684e commit d922c81e002f78bcf13779b7c1929fdcf1c11798 @danbernier committed May 31, 2012
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.md
View
@@ -0,0 +1,19 @@
+# Regex Parser?
+
+This is all based on [Russ Cox' paper about fast-matching regular
+expressions](http://swtch.com/~rsc/regexp/regexp1.html). It's a neat
+paper, you should check it out.
+
+# What's it do so far?
+
+Read the code, there's not much of it. But the idea is, you hand-roll
+a deterministic finite automata (see the Node class), and it has
+methods for matching a string (returns a boolean), and generating
+sample strings (by walking the finite automata).
+
+# TODO
+
+1. It's all in one file right now. Break it out into files.
+1. Add some minitests.
+1. Implement a pattern parser & builder.
+1. Add non-literals to the patterns, so things like @.@, @[0-9]@, and @\d@ work.

0 comments on commit d922c81

Please sign in to comment.