Small fix to documentation.
[miniexpect.git] / README
1 miniexpect is a very simple expect-like library for C.
2
3 It has a saner interface than libexpect, and doesn't depend on Tcl.
4 It is also thread safe, const-correct and uses modern C standards.
5
6 It is standalone, except that it requires the PCRE (Perl Compatible
7 Regular Expressions) library from http://www.pcre.org/.  The PCRE
8 dependency is fundamental because we want to offer the most powerful
9 regular expression syntax to match on, but more importantly because
10 PCRE has a convenient way to detect partial matches which made this
11 library very simple to implement.
12
13 License
14 -------
15
16 The library was written by Richard W.M. Jones <rjones@redhat.com>
17 and is licensed under the Library GPL (LGPL) version 2 or above.
18
19 Source is available from: http://git.annexia.org/?p=miniexpect.git;a=summary
20
21 Using the library
22 -----------------
23
24 If you wanted to copy the library into your own code (instead of
25 linking to it as a dependency), you only need to copy the two files:
26 miniexpect.h, miniexpect.c.
27
28 The API is documented in the manual page (miniexpect.pod / miniexpect.3).
29
30 For examples of how to use the API in reality, see the examples and
31 tests in the source directory.