From 01537e3bc049399b346bd826f639881c2796e976 Mon Sep 17 00:00:00 2001 From: Joachim Nilsson Date: Wed, 28 Jan 2015 23:13:20 +0100 Subject: [PATCH] Cleanup and improve Markdown syntax, inspired by libuEv Still need to add an API overview and a useful but still simple example. Signed-off-by: Joachim Nilsson --- README.md | 87 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 59 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index feb9360..6f2ad79 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,69 @@ -editline -======== -[![Build Status](https://travis-ci.org/troglobit/editline.png?branch=master)](https://travis-ci.org/troglobit/editline)[![Coverity Scan Status](https://scan.coverity.com/projects/2982/badge.svg)](https://scan.coverity.com/projects/2982) +Minix Editline +============== +[![Build Status](https://travis-ci.org/troglobit/editline.png?branch=master)](https://travis-ci.org/troglobit/editline) +[![Coverity Scan Status](https://scan.coverity.com/projects/2982/badge.svg)](https://scan.coverity.com/projects/2982) -This is a line editing library. It can be linked into almost any program to -provide command-line editing and history. It is call-compatible with the FSF -readline library, but is a fraction of the size (and offers fewer features). -The editline library was created by Simmule Turner and Rich Salz back in 1992. -At the time they chose to distribute the code under a "C News-like" copyright, -see the file LICENSE for details. +Introduction +------------ -The small size (<30k), lack of dependencies (no ncurses needed!) and the free -license should make this library interesting to many embedded developers. +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. -Configuration is made by supplying different options to the GNU configure -script. In the `examples/` directory you can find some small code snippets used -for testing. +The small size (<30k), lack of dependencies (no ncurses needed!), and +the free license should make this library interesting to many embedded +developers. -This version of the editline library is a fork off the Minix3 sources. Other -know versions, often based off of the original comp.sources.unix posting are: +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. -* Debian [libeditline](http://packages.qa.debian.org/e/editline.html) -* [Heimdal](http://www.h5l.org) -* [Festival speech-tools](http://festvox.org/festival/) -* Steve Tell's [editline patches](http://www.cs.unc.edu/~tell/dist.html) -The most intersting patches and bug fixes from each fork have been merged here. -Outstanding issues are listed in the TODO file. +API +--- -An explanation of the version numbering may be in order. I didn't know about -the Debian version for quite some time, so I kept a different name for the -package and a different versioning scheme. In June 2009, I decided to line up -alongside Debian, with the intent of merging the efforts. +*TODO* ----- -Joachim Nilsson <[troglobit()gmail!com](mailto:troglobit@gmail!com)> +Example +------- + +*TODO* + + +Origin & References +-------------------- + +The editline library was created by Simmule Turner and Rich Salz back in +in 1992. It is distributed under a "C News-like" license, similar to +the [BSD License]. For details, see the file LICENSE. + +This version of the editline library is forked from the [Minix 3] tree. +Other known versions, often based off of the original comp.sources.unix +posting, are: + +* Debian [libeditline] +* [Heimdal] +* [Festival] speech-tools +* [Steve Tell]'s editline patches + +The most intersting patches and bug fixes from each fork have been +merged here. Outstanding issues are listed in the TODO file. + +An explanation of the version numbering may be in order. I didn't know +about the Debian version for quite some time, so I kept a different name +for the package and a different versioning scheme. In June 2009, I +decided to line up alongside Debian, with the intent of eventually +merging the efforts. However, despite several attempts, the Debian +maintainer has not responded to my emails. + + +[Minix 3]: http://www.minix3.org/ +[BSD License]: http://en.wikipedia.org/wiki/BSD_licenses +[libeditline]: http://packages.qa.debian.org/e/editline.html +[Heimdal]: http://www.h5l.org +[Festival]: http://festvox.org/festival/ +[Steve Tell]: http://www.cs.unc.edu/~tell/dist.html