diff --git a/README b/README.md similarity index 63% rename from README rename to README.md index 16cb9a6..469d689 100644 --- a/README +++ b/README.md @@ -1,14 +1,23 @@ +# sqlfun + An SQL parser, generated from Bison (Yacc) and Flex (Lex). Original version - most of the work - comes from John Levine's Flex & Bison book published by O'Reilley. -Example usage: +## Example usage: $ echo "SELECT a.name,b.address FROM people ORDER BY name;" | ./sql -Standard GNU autotools building instructions: +## Requirements + +1. GNU Flex +2. GNU bison +3. GNU autotools (autoconf, automake, etc.) +4. A C compiler + +## Standard GNU autotools building instructions: $ ./autogen.sh $ ./configure