Use CMake

[linenoise.git] / README.markdown

diff --git a/README.markdown b/README.markdown
index c07fd652b3ce625d1ac67fc4c33175fbe8ffbbfe..70cba8b32eb3364d6d96e88f45883a91d789eca0 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -1,14 +1,49 @@
 # Linenoise
 
+## What's different in this fork?
+
+- Win32 console
+- full utf8 support (what about utf8 on windows)
+- insert control characters
+- no hints yet
+- now with multiline
+
+## How do I include linenoise line editing support in my application?
+
+From the Makefile:
+
+  linenoise-ship.c simplifies delivery of linenoise support
+
+  simple copy linenoise-ship.c to linenoise.c in your application, and also linenoise.h
+
+  * If you want win32 support, also copy linenoise-win32.c
+  * If you never want to support utf-8, you can omit utf8.h and utf8.c
+
+To enable utf-8 support, define USE_UTF8
+
+## Where do I get it?
+
+Get it here: [https://github.com/msteveb/linenoise](https://github.com/msteveb/linenoise)
+
+--------------------------------------------------------
+
+## Original README below
+
+Can a line editing library be 20k lines of code?
+
 A minimal, zero-config, BSD licensed, readline replacement.
 
+News: linenoise now includes minimal completion support, thanks to Pieter Noordhuis (@pnoordhuis).
+
+News: linenoise is now part of [Android](http://android.git.kernel.org/?p=platform/system/core.git;a=tree;f=liblinenoise;h=56450eaed7f783760e5e6a5993ef75cde2e29dea;hb=HEAD Android)!
+
 ## Can a line editing library be 20k lines of code?
 
 Line editing with some support for history is a really important feature for command line utilities. Instead of retyping almost the same stuff again and again it's just much better to hit the up arrow and edit on syntax errors, or in order to try a slightly different command. But apparently code dealing with terminals is some sort of Black Magic: readline is 30k lines of code, libedit 20k. Is it reasonable to link small utilities to huge libraries just to get a minimal support for line editing?
 
 So what usually happens is either:
 
- * Large programs with configure scripts disabling line editing if readline is not present in the system, or not supporting it at all since readline is GPL licensed and libedit (the BSD clone) is not as known and available as readline is (Readl world example of this problem: Tclsh).
+ * Large programs with configure scripts disabling line editing if readline is not present in the system, or not supporting it at all since readline is GPL licensed and libedit (the BSD clone) is not as known and available as readline is (Real world example of this problem: Tclsh).
  * Smaller programs not using a configure script not supporting line editing at all (A problem we had with Redis-cli for instance).
  
 The result is a pollution of binaries without line editing support.
@@ -21,7 +56,7 @@ Apparently almost every terminal you can happen to use today has some kind of su
 
 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 less than 400 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 less than 2000 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.
 
 ## Tested with...