Mercurial > lbo > hg > rex
changeset 99:6594ca027919 default tip master
Update README
author | Lewin Bormann <lbo@spheniscida.de> |
---|---|
date | Thu, 10 Dec 2020 09:13:15 +0100 |
parents | f2404211c184 |
children | |
files | README.md |
diffstat | 1 files changed, 9 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/README.md Thu Dec 10 09:07:00 2020 +0100 +++ b/README.md Thu Dec 10 09:13:15 2020 +0100 @@ -2,12 +2,17 @@ ![CI](https://github.com/dermesser/rex/workflows/CI/badge.svg) -rex is a mere playground where I'm trying to write an engine for parsing, -compiling and matching regular expressions. +Rex is a straight-forward regular expression engine based on state machines, +with the *secondary* goal of having similar complexity characteristics as RE2 (of course +without being so fast, as that entails a lot more work). On various pathological +REs this goal has already been achieved. -It's a bit slow right now, but generally works. +The primary goal however is to have a navigable documented code base for a +regular expression engine. For this purpose, there is an all-members-documented +documentation available at +[borgac.net/~lbo/doc/rex\_regex/rex\_regex/](https://borgac.net/~lbo/doc/rex_regex/rex_regex/). -Consider the code licensed under the MIT license. +Benchmarks can be run with `cargo bench`. ## Bugs