Linenoise README updated to match source code.

This commit is contained in:
antirez 2014-10-06 09:49:44 +02:00
parent 3c6f9ac37c
commit e4b0c8ec50

View File

@ -7,6 +7,7 @@ MongoDB, and Android.
* History handling. * History handling.
* Completion. * Completion.
* About 1,100 lines of BSD license source code. * About 1,100 lines of BSD license source code.
* Only uses a subset of VT100 escapes (ANSI.SYS compatible).
## Can a line editing library be 20k lines of code? ## Can a line editing library be 20k lines of code?
@ -23,9 +24,8 @@ So I spent more or less two hours doing a reality check resulting in this little
## Terminals, in 2010. ## Terminals, in 2010.
Apparently almost every terminal you can happen to use today has some kind of support for VT100 alike escape sequences. So I tried to write a lib using just very basic VT100 features. The resulting library appears to work everywhere I tried to use it. Apparently almost every terminal you can happen to use today has some kind of support for basic VT100 escape sequences. So I tried to write a lib using just very basic VT100 features. The resulting library appears to work everywhere I tried to use it, and now can work even on ANSI.SYS compatible terminals, since no
VT220 specific sequences are used anymore.
Since it's so young I guess there are a few bugs, or the lib may not compile or work with some operating system, but it's a matter of a few weeks and eventually we'll get it right, and there will be no excuses for not shipping command line tools without built-in line editing support.
The library is currently about 1100 lines of code. In order to use it in your project just look at the *example.c* file in the source distribution, it is trivial. Linenoise is BSD code, so you can use both in free software and commercial software. The library is currently about 1100 lines of code. In order to use it in your project just look at the *example.c* file in the source distribution, it is trivial. Linenoise is BSD code, so you can use both in free software and commercial software.
@ -40,6 +40,7 @@ The library is currently about 1100 lines of code. In order to use it in your pr
* OpenBSD 4.5 through an OSX Terminal.app ($TERM = screen) * OpenBSD 4.5 through an OSX Terminal.app ($TERM = screen)
* IBM AIX 6.1 * IBM AIX 6.1
* FreeBSD xterm ($TERM = xterm) * FreeBSD xterm ($TERM = xterm)
* ANSI.SYS
Please test it everywhere you can and report back! Please test it everywhere you can and report back!