Skip to content

Commit 227f4ac

Browse files
committed
Naming.
1 parent 20f262c commit 227f4ac

File tree

2 files changed

+4
-7
lines changed

2 files changed

+4
-7
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,15 @@
44
; re -cb -pl dot '[Ll]ibf+(sm)*' '[Ll]ibre' | dot
55
![libfsm.svg](doc/tutorial/libfsm.svg)
66

7+
libfsm is not a drop-in replacement for other regex engines, and it only supports patterns that can be compiled to deterministic FSMs. In return, supported patterns run in linear time.
8+
79
Getting started:
810

911
* See the [tutorial introduction](doc/tutorial/re.md) for a quick overview
1012
of the re(1) command line interface.
1113
* [Compilation phases](doc/tutorial/phases.md) for typical applications
1214
which compile regular expressions to code.
15+
* [Advice on using libfsm](doc/advice.md) for suggestions around compilation time, unsupported features, common usage patterns, and examples.
1316

1417
You get:
1518

@@ -24,12 +27,6 @@ lx is an attempt to produce a simple, expressive, and unobtrusive
2427
lexer generator which is good at lexing, does just lexing,
2528
is language independent, and has no other features.
2629

27-
### Performance and Requirements
28-
29-
libfsm is not a drop-in replacement for other regex engines and it only supports patterns that can be compiled to deterministic FSMs. In return, supported patterns run in linear time.
30-
31-
**→ See [doc/GUIDE.md](doc/GUIDE.md) for detailed unsupported features, usage patterns, and examples.**
32-
3330
### Building from source
3431

3532
Clone with submodules (contains required .mk files):

doc/GUIDE.md renamed to doc/advice.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Using libfsm for High-Performance Pattern Matching
1+
# Advice on using libfsm for high-performance pattern matching
22

33
libfsm compiles regular expressions to deterministic finite state machines (FSMs) and generates executable code. FSM-based matching runs in **linear time O(n)** with **no backtracking**.
44

0 commit comments

Comments
 (0)