xref: /aosp_15_r20/external/cronet/third_party/re2/src/README (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1This is the source code repository for RE2, a regular expression library.
2
3For documentation about how to install and use RE2,
4visit https://github.com/google/re2/.
5
6The short version is:
7
8make
9make test
10make install
11make testinstall
12
13Building RE2 requires Abseil (https://github.com/abseil/abseil-cpp)
14to be installed on your system. Building the testing for RE2 requires
15GoogleTest (https://github.com/google/googletest) and Benchmark
16(https://github.com/google/benchmark) to be installed as well.
17
18There is a fair amount of documentation (including code snippets) in
19the re2.h header file.
20
21More information can be found on the wiki:
22https://github.com/google/re2/wiki
23
24Issue tracker:
25https://github.com/google/re2/issues
26
27Mailing list:
28https://groups.google.com/group/re2-dev
29
30Unless otherwise noted, the RE2 source files are distributed
31under the BSD-style license found in the LICENSE file.
32
33RE2's native language is C++.
34
35The Python wrapper is at https://github.com/google/re2/tree/main/python
36and on PyPI (https://pypi.org/project/google-re2/).
37
38A C wrapper is at https://github.com/marcomaggi/cre2/.
39A D wrapper is at https://github.com/ShigekiKarita/re2d/ and on DUB (code.dlang.org).
40An Erlang wrapper is at https://github.com/dukesoferl/re2/ and on Hex (hex.pm).
41An Inferno wrapper is at https://github.com/powerman/inferno-re2/.
42A Node.js wrapper is at https://github.com/uhop/node-re2/ and on NPM (npmjs.com).
43An OCaml wrapper is at https://github.com/janestreet/re2/ and on OPAM (opam.ocaml.org).
44A Perl wrapper is at https://github.com/dgl/re-engine-RE2/ and on CPAN (cpan.org).
45An R wrapper is at https://github.com/girishji/re2/ and on CRAN (cran.r-project.org).
46A Ruby wrapper is at https://github.com/mudge/re2/ and on RubyGems (rubygems.org).
47A WebAssembly wrapper is at https://github.com/google/re2-wasm/ and on NPM (npmjs.com).
48