Skip to content

Commit 7cd850a

Browse files
committed
doc: remove HACKING document
It is almost completely wrong now. Instead of rewriting it---which would be a huge endeavor---we just point folks toward my blog on regex internals. Closes #1058
1 parent d53fe59 commit 7cd850a

File tree

2 files changed

+15
-341
lines changed

2 files changed

+15
-341
lines changed

HACKING.md

-341
This file was deleted.

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,21 @@ $ rebar cmp results.csv
290290
See the `rebar` documentation for more details on how it works and how to
291291
compare results with other regex engines.
292292

293+
294+
### Hacking
295+
296+
The `regex` crate is, for the most part, a pretty thin wrapper around the
297+
[`meta::Regex`](https://docs.rs/regex-automata/latest/regex_automata/meta/struct.Regex.html)
298+
from the
299+
[`regex-automata` crate](https://docs.rs/regex-automata/latest/regex_automata/).
300+
Therefore, if you're looking to work on the internals of this crate, you'll
301+
likely either want to look in `regex-syntax` (for parsing) or `regex-automata`
302+
(for construction of finite automata and the search routines).
303+
304+
My [blog on regex internals](https://blog.burntsushi.net/regex-internals/)
305+
goes into more depth.
306+
307+
293308
### Minimum Rust version policy
294309

295310
This crate's minimum supported `rustc` version is `1.60.0`.

0 commit comments

Comments
 (0)