diff --git a/README.md b/README.md index 8ba3cba..699f03d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ Kraken The Kraken Programming Language The Kraken Programming Language is in its infancy. +Currently, it consists of a RNGLALR parser written in C++ and a very experimental grammer that is evolving quickly. +When compiled, the kraken program (as it is not yet a compiler) will take in a text file to be parsed, the grammer file to use, and a filename to output a DOT file to. +Kraken will then generate the RN parsing tables from the grammer and then parse the input and export a DOT file that can be renderd into a graph using Graphviz. + +It is invoked in this way: +kraken inputTextFile inputGrammerFile outputFile.dot + +It is built using CMake, which is also its only dependency. It has the following design goals: -Compiled