From 4e138b38eb9c41d7ef110dd1841122f5861ab244 Mon Sep 17 00:00:00 2001
From: Adrian Kummerländer
Date: Sun, 6 Jan 2013 00:28:06 +0100
Subject: Added a basic readme file

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..46284c9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# SimpleParser
+
+... is a simple parser for resolving mathematical terms. 
+
+The term is parsed by generating a binary expression tree using the [Shunting-Yard](http://en.wikipedia.org/wiki/Shunting-yard_algorithm) algorithm.
+The implementation itself does not use any external libraries and relies fully on the features provided by the C++ language and the STL.
+
+## Current features:
+
+- Calculating terms with basic operators while respecting the priority of each operator
+- Support for brackets
+- Export of the expression tree as [Graphviz](http://www.graphviz.org/) dot for visualization
+
+## Requirements
+
+- C++ compiler with support for new C++11 and STL features such as the auto keyword and unique_ptr (tested with GCC 4.7.2 on Linux)
+- [GoogleTest](http://code.google.com/p/googletest/) for tests
-- 
cgit v1.2.3