summaryrefslogtreecommitdiff
path: root/libraries/lua-lpeg/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/lua-lpeg/README')
-rw-r--r--libraries/lua-lpeg/README11
1 files changed, 11 insertions, 0 deletions
diff --git a/libraries/lua-lpeg/README b/libraries/lua-lpeg/README
new file mode 100644
index 0000000000..1ef11d574e
--- /dev/null
+++ b/libraries/lua-lpeg/README
@@ -0,0 +1,11 @@
+LPeg is a new pattern-matching library for Lua, based on Parsing Expression
+Grammars (PEGs).
+
+The library offers several functions to create and compose patterns. With the
+use of metamethods, several of these functions are provided as infix or prefix
+operators. On the one hand, the result is usually much more verbose than the
+typical encoding of patterns using the so called regular expressions (which
+typically are not regular expressions in the formal sense). On the other hand,
+first-class patterns allow much better documentation (as it is easy to comment
+the code, to break complex definitions in smaller parts, etc.) and are
+extensible, as we can define new functions to create and compose patterns.