Readme added, some outdated notes removed

1 files changed, 50 insertions, 0 deletions

diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..bc2d77b
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,50 @@
+
+
+Packrat Parser Combinators
+==========================
+
+
+
+
+This is a parser combinator library that can handle ambiguous left-recursive
+grammars in at most polynomial time and space complexity. It does this by
+memoizing all intermediate parse results and deduplicating them inside a
+specialised parse graph structure.
+
+For more extensive documentation including a quick start guide and short
+explanations of individual combinators, see the /doc/index.html file.
+
+
+
+
+Dependencies:
+
+    GNAT
+    directed-graph
+    basic-unit-test (only if compiling the unit test suite)
+
+
+
+
+How to build/install:
+
+This repository is written to use the GNAT Project Manager build tools. To
+build Packrat, use the following command
+
+    gprbuild packrat.gpr -Xmode=release
+
+And to install the library, use
+
+    gprinstall -p -m packrat.gpr
+
+The other project files (tests.gpr and examples.gpr) are for the unit test
+suite and the provided examples of how to use this library.
+
+
+
+
+For further information on the build tools, consult
+
+    https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug.html
+
+