cdo/regex-engine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add more info to README

Browse Source
This commit is contained in:
Camden Dixie O'Brien 2024-10-25 19:09:36 +01:00
parent 01fb9be1e7
commit a85367c2df
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README
View File

@ -4,6 +4,7 @@ I've thought for a while it would be fun and interesting to write my
own regular expression engine using Thompson's construction algorithm,
so here we are.
Grammar
This engine is not going to be strictly supporting any standard
@ -16,3 +17,18 @@ syntax; the expression syntax I intend to support follows.
literal ::= non-special | '\' special
quantifier ::= '*' | '+' | '?'
special ::= quantifier | '|' | '(' | ')' | '[' | ']' | '^' | '\'
Building and Running Tests
There are two scripts, build.sh and test.sh, which will (much to
everybody's shock) build and run tests. The build script uses Clang
but the code is ISO C11 so it should compile just fine with GCC or
something instead.
sh scripts/build.sh # Compile library and test code
sh scripts/test.sh # Run tests
There is also an entr.sh script which will watch all the project's
files and rebuild and rerun the tests on any changes, using the entr
tool.