Browse files

Filled up readme

  • Loading branch information...
1 parent e2d7fee commit 8d3d2eeee9b73b4de2da316a9430682b7b8a686b n ddrylliog committed Nov 1, 2009
Showing with 37 additions and 12 deletions.
  1. +0 −12 README
  2. +37 −0 README.rst
View
12 README
@@ -1,12 +0,0 @@
-leg grammar for ooc
-
-it's intended to be pretty simple, a starting point
-to be used in your next IDE/doc tool/refactoring tool/
-syntax highlighting/cool ooc project, as it was
-the starting point of rock, our brand new compiler.
-
-nagaqueen is a work in progress, so if it doesn't
-parse everything, don't sweat it, there should be
-improvements every few hours.
-
-and don't forget to have fun!
View
37 README.rst
@@ -0,0 +1,37 @@
+nagaqueen: a leg grammar for ooc
+================================
+
+why a grammar?
+--------------
+
+ - for rock, our new compiler
+ - for you to learn the language
+ - for your next project to parse ooc easily
+
+does it work?
+-------------
+
+nagaqueen is a work in progress, so if it doesn't
+parse everything, don't sweat it, there should be
+improvements every few hours.
+
+what is leg?
+------------
+
+Ian Piumarta's peg/leg (v0.14+) is a modern parser generator
+based on the PEG paper, it allows to define a grammar in a
+simple and straight-forward way
+
+get it while it's hot: http://piumarta.com/software/peg/
+
+how to test it?
+---------------
+
+ - install peg/leg
+ - run 'make test'
+ - PROFIT!
+
+don't be shy. open the grammar, modify it to see the effects.
+it can't hurt, and is actually pretty simple to understand =)
+
+have fun!

0 comments on commit 8d3d2ee

Please sign in to comment.