Create Markdown versions of README and NEWS and update for release

Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
This commit is contained in:
Joachim Nilsson 2014-09-14 03:50:37 +02:00
parent 08b7f57c98
commit 9cc0cc1ccd
4 changed files with 89 additions and 50 deletions

14
NEWS
View File

@ -1,14 +0,0 @@
Notable Changes
* v1.13.0 - Adaptations to Debian editline package
** Major version number bump, adapt to Jum Studt's v1.12
** Import debian/ directory and adapt it to configure et al.
** Change library name to libeditline to distinguish it from BSD libedit.
* v0.3.0
** Support for ANSI arrow keys using --enable-arrow-keys
* v0.2.x
** Patches from Debian package merged.
** Support for custom command completion.

1
NEWS Symbolic link
View File

@ -0,0 +1 @@
NEWS.md

50
NEWS.md Normal file
View File

@ -0,0 +1,50 @@
ChangeLog
=========
Notable Changes
* v1.14.2 - Bug fixes only
- Fix `el_no_echo` bug causing secrets to leak when disabling no-echo
- Handle `EINTR` in syscalls better
* v1.14.1 - Minor fixes and additions
- Don't print status message on `stderr` in key binding funcions
- Export `el_del_char()`
- Check for and return pending signals when detected
- Allow custom key bindings ...
- Bug fixes ...
* v1.14.0 - Major cleanups and further merges with Debian editline package
- Merge in changes to `debian/` from editline_1.12-6.debian.tar.gz
- Migrate to use libtool
- Cleanups and fixes thanks to the Sparse static code analysis tool
- Make `UNIQUE_HISTORY` configurable
- Make scrollback history (`HIST_SIZE`) configurable
- Configure options for toggling terminal bell and `SIGSTOP` (Ctrl-Z)
- Configure option for using termcap to read/control terminal size
- Merge `el_no_echo` patch from Festival speech-tools
- Rename Signal to `el_intr_pending`, from Festival speech-tools
- Merge support for capitalizing words (`M-c`) from Festival
speech-tools by Alan W Black <awb()cstr!ed!ac!uk>
- Merge fixes from Heimdal project
- Completely refactor `rl_complete()` and `rl_list_possib()` with
fixes from the Heimdal project. Use `rl_set_complete_func()` and
`rl_set_list_possib_func()`. Default completion callbacks are now
available as a configure option `--enable-default-complete`
- Memory leak fixes
- Fallback backspace handling, in case `tgetstr("le")` fails
- Actually fix 8-bit handling by reverting old Debian patch
- Merge patch to improve compatibility with GNU readline, thanks to
Steve Tell from way back in 1997 and 1998
* v1.13.0 - Adaptations to Debian editline package
- Major version number bump, adapt to Jum Studt's v1.12
- Import `debian/` directory and adapt it to configure et al.
- Change library name to libeditline to distinguish it from BSD libedit
* v0.3.0
- Support for ANSI arrow keys using `--enable-arrow-keys`
* v0.2.x
- Patches from Debian package merged
- Support for custom command completion

36
README
View File

@ -1,36 +0,0 @@
README -*-text-*-
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.
The small size (<30k), lack of dependencies (no ncurses needed!) and the free
license should make this library interesting to many embedded developers.
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.
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:
* 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.
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.
Enjoy,
Joachim Nilsson <troglobit()gmail!com>

1
README Symbolic link
View File

@ -0,0 +1 @@
README.md

37
README.md Normal file
View File

@ -0,0 +1,37 @@
editline
========
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.
The small size (<30k), lack of dependencies (no ncurses needed!) and the free
license should make this library interesting to many embedded developers.
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.
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:
* 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.
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.
----
Joachim Nilsson <[troglobit()gmail!com](mailto:troglobit@gmail!com)>