]> git.mdlowis.com Git - archive/parse-utils.git/commitdiff
Updated readme
authorMike D. Lowis <mike@mdlowis.com>
Thu, 1 Mar 2012 14:10:17 +0000 (09:10 -0500)
committerMike D. Lowis <mike@mdlowis.com>
Thu, 1 Mar 2012 14:10:17 +0000 (09:10 -0500)
README.md

index 6e37ab710cf5dc5e1e3b103afb26fb9945943aeb..73aff42e62f645c4f18f94d3bd0e05332822f8f3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,16 @@
 Project Template
 ==============================================
-Version:      0.1
-Created By:   Michael D. Lowis
-Email:        mike@mdlowis.com
+Version:      0.1<br>
+Created By:   Michael D. Lowis<br>
+Email:        <mike@mdlowis.com><br>
 
 About This Project
 ----------------------------------------------
-
+This is project implements a library of useful classes for developing recursive
+descent parsers in c++. The library provides a generic abstract syntax tree
+class, lexer and parser base classes, as well as a tree visistor class with a
+useful implementation for pretty printing an arbitrary syntax tree. Users of
+this library can link against it statically or dynamically.
 
 License
 ----------------------------------------------
@@ -14,16 +18,6 @@ Unless explicitly stated otherwise, all code, documentation, and files contained
 within this repository are released under the BSD 2-clause license.
 See LICENSE.md for more details
 
-Requirements
-----------------------------------------------
-
-*   Some application (version info)
-*   Some library (version info)
-
-Installation
-----------------------------------------------
-
-
 Project Files and Directories
 ----------------------------------------------
     build/         Output directory for build artifacts
@@ -38,28 +32,3 @@ Project Files and Directories
     rakefile.rb    Rakefile containing build tasks
     README.md
 
-Know Issues or Bugs
-----------------------------------------------
-
-* Generic Issue #1
-* Generic Issue #2
-* Generic Issue #3
-
-Version History
-----------------------------------------------
-
-
-Feature Wish List
-----------------------------------------------
-
-This is a list of features are not yet supported but may be at some point in
-the future.
-
-* Generic feature description #1
-* Generic feature description #2
-* Generic feature description #3
-
-More Info
-----------------------------------------------
-
-