X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=README;h=030d26570f4192b9e1ce2b7512842e78f3d3f32f;hb=b300de9ac244ef5fd315228bce69c2b938dc77f4;hp=f7399404f88052c656d67eb0607e55cc3d36d113;hpb=5cac23de1963880d8fb3aed4be47ec2894cf520c;p=miniexpect.git diff --git a/README b/README index f739940..030d265 100644 --- a/README +++ b/README @@ -1,14 +1,19 @@ -miniexpect is a very simple expect-like library for C. +Miniexpect is a very simple expect-like library -It has a saner interface than libexpect, and doesn't depend on Tcl. -It is also thread safe, const-correct and uses modern C standards. +Expect (https://core.tcl-lang.org/expect/index) is a venerable Tcl +program for automating interactive services, often for automating +logins over telnet, ftp, ssh, etc. -It is standalone, except that it requires the PCRE (Perl Compatible -Regular Expressions) library from http://www.pcre.org/. The PCRE -dependency is fundamental because we want to offer the most powerful -regular expression syntax to match on, but more importantly because -PCRE has a convenient way to detect partial matches which made this -library very simple to implement. +Miniexpect is a C library which has a saner interface than libexpect, +and doesn't depend on Tcl. It is also thread safe, const-correct and +uses modern C standards. + +Miniexpect is standalone, except that it requires the PCRE2 (Perl +Compatible Regular Expressions) library from http://www.pcre.org/. +The PCRE2 dependency is fundamental because we want to offer the most +powerful regular expression syntax to match on, but more importantly +because PCRE2 has a convenient way to detect partial matches which +made miniexpect very simple to implement. License ------- @@ -21,7 +26,11 @@ Source is available from: http://git.annexia.org/?p=miniexpect.git;a=summary Using the library ----------------- -The API is described in miniexpect.h. +If you wanted to copy the library into your own code (instead of +linking to it as a dependency), you only need to copy the two files: +miniexpect.h, miniexpect.c. + +The API is documented in the manual page (miniexpect.pod / miniexpect.3). -To understand how to use the API, take a look at the examples and +For examples of how to use the API in reality, see the examples and tests in the source directory.