~brenns10/sc-regex

42980881e25d0ad6c896d1d76489373c2dd865d5 — Stephen Brennan 6 months ago 0f51e45
Add README
1 files changed, 25 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +25 -0
@@ 0,0 1,25 @@
sc-regex
--------

`sc-regex` is a simple C regular expression library. It allows most common
features of regular expressions, without dangerous ones such as backreferences,
etc. It is part of the "sc" (Stephen's C) family of libraries. For complete
examples on the use of this library, see the [sc-examples][1] repository.

[1]: https://git.sr.ht/~brenns10/sc-examples

Development
-----------

Run the following to create a build directory:

    meson build

You may then compile (or re-compile) with:

    ninja -C build

When you would like to commit your changes, please ensure that you have
pre-commit hooks installed, so that automated checks can run on your code:

    pre-commit install