diff --git a/README.md b/README.md index a68cddf..a5fb258 100644 --- a/README.md +++ b/README.md @@ -16,20 +16,20 @@ Table of Contents Introduction ------------ -This is a small [line editing][] library. It can be linked into almost -any program to provide command line editing and history functions. It -is call compatible with the [FSF readline][] library, but at a fraction -of the size, and as a result fewer features. It is also distributed +This is a small [line editing][] library. It can be linked into almost +any program to provide command line editing and history functions. It +is call compatible with the [FSF readline][] library, but at a fraction +of the size, and as a result fewer features. It is also distributed under a much more liberal [LICENSE][]. -The small size (<30k), lack of dependencies (no ncurses needed!), and -the free license should make this library interesting to many embedded +The small size (<30k), lack of dependencies (ncurses not needed!), and +the free license should make this library interesting to many embedded developers. Editline has several optional build-time features that can be enabled by -by supplying different options to the GNU configure script. See the -output from configure --help for details. In the `examples/` -directory you can find some small code snippets used for testing. +supplying different options to the GNU configure script. See the output +from configure --help for details. Some useful hints on how +to use the library is available in the `examples/` directory. Editline is maintained collaboratively at [GitHub][]. @@ -125,46 +125,47 @@ Build & Install Editline was originally designed for older UNIX systems and Plan 9. The current maintainer works exclusively on GNU/Linux systems, so it may use -GCC and GNU Make specific extensions here and there. This is not on +GCC and GNU Make specific extensions here and there. This is not on purpose and patches or pull requests to correct this are most welcome! 1. Configure editline with default features: ./configure 2. Build the library and examples: make all 3. Install using make install -The `$DESTDIR` environment variable is honored at install. See -./configure --help for more options. +The `$DESTDIR` environment variable is honored at install. For more +options, see ./configure --help + Origin & References -------------------- -This [line editing][] library was created by Simmule Turner and -[Rich Salz][upstream] in in 1992. It is distributed under a “C -News-like” license, similar to the [BSD license][]. Rich's latest -version is however under the Apache license. For details on the -licensing terms of this version of the software, see [LICENSE][]. +This [line editing][] library was created by [Rich Salz][] and Simmule +Turner and in 1992. It is distributed under a “C News-like” license, +similar to the [BSD license][]. Rich's latest version is however under +the Apache license. For details on the licensing terms of this version +of the software, see [LICENSE][]. -This version of the editline library was forked from the [Minix 3][] -source tree and is *not* related to the similarily named NetBSD version -that [Jess Thrysøe][jess] disitributes to the world outside BSD. The -libraries have much in common, but the latter is heavily refactored and -also relies on libtermcap (usually supplied by ncurses), whereas this +This version of the editline library was forked from the [Minix 3][] +source tree and is *not* related to the similarily named NetBSD version +that [Jess Thrysøe][jess] disitributes to the world outside *BSD. The +libraries have much in common, but the latter is heavily refactored and +also relies on libtermcap (usually supplied by ncurses), whereas this library only uses termios from the standard C library. -Patches and bug fixes from the following forks, all based on the -original comp.sources.unix posting, have been merged: +Patches and bug fixes from the following forks, based on the original +[comp.sources.unix][] posting, have been merged: * Debian [libeditline][] * [Heimdal][] * [Festival][] speech-tools * [Steve Tell][]'s editline patches -The version numbering scheme today follows that of the Debian version, -which can be seen in the [ChangeLog.md][]. The Debian version was -unknown to the current [maintainer][] for quite some time, so a -different name and different versioning scheme was used. In June 2009 -this was changed to line up alongside Debian, with the intent is to -eventually merge the efforts. +The version numbering scheme today follows that of the Debian version, +details available in the [ChangeLog.md][]. The current [maintainer][] +was unaware of the Debian version for quite some time, so a different +name and versioning scheme was used. In June 2009 this was changed to +line up alongside Debian, with the intent is to eventually merge the +efforts. Outstanding issues are listed in the [TODO.md][] file. @@ -175,7 +176,8 @@ Outstanding issues are listed in the [TODO.md][] file. [TODO.md]: https://github.com/troglobit/editline/blob/master/TODO.md [ChangeLog.md]: https://github.com/troglobit/editline/blob/master/ChangeLog.md [FSF readline]: http://www.gnu.org/software/readline/ -[upstream]: https://github.com/richsalz/editline/ +[Rich Salz]: https://github.com/richsalz/editline/ +[comp.sources.unix]: http://ftp.cs.toronto.edu/pub/white/pub/rc/editline.shar [Minix 3]: http://www.cise.ufl.edu/~cop4600/cgi-bin/lxr/http/source.cgi/lib/editline/ [jess]: http://thrysoee.dk/editline/ [BSD license]: http://en.wikipedia.org/wiki/BSD_licenses @@ -187,9 +189,3 @@ Outstanding issues are listed in the [TODO.md][] file. [Travis Status]: https://travis-ci.org/troglobit/editline.png?branch=master [Coverity Scan]: https://scan.coverity.com/projects/2982 [Coverity Status]: https://scan.coverity.com/projects/2982/badge.svg - -