Add explicit support for single-file delivery

Signed-off-by: Steve Bennett <steveb@workware.net.au>

diff --git a/Makefile b/Makefile
index 251029ecc504282d7c20b092732ed518fab25ad0..f4638e2d74d05aaf45f65641c31de5d9388d3907 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,13 +1,23 @@
 CFLAGS += -Wall -W -Os -g -Wno-unused-parameter
-CC := gcc
+CC ?= gcc
 
 all:  linenoise_example linenoise_utf8_example
 
-linenoise_example: linenoise.h linenoise.c  stringbuf.c stringbuf.h linenoise-win32.c example.c
-       $(CC) $(CFLAGS) -o $@ linenoise.c example.c stringbuf.c
+linenoise_example: linenoise.h linenoise-ship.c linenoise-win32.c example.c
+       $(CC) $(CFLAGS) -o $@ linenoise-ship.c example.c
 
-linenoise_utf8_example: linenoise.h linenoise.c  stringbuf.c stringbuf.h utf8.c linenoise-win32.c
-       $(CC) $(CFLAGS) -DUSE_UTF8 -o $@ linenoise.c utf8.c example.c stringbuf.c
+linenoise_utf8_example: linenoise.h linenoise-ship.c linenoise-win32.c
+       $(CC) $(CFLAGS) -DUSE_UTF8 -o $@ linenoise-ship.c example.c
 
 clean:
-       rm -f linenoise_example linenoise_utf8_example *.o
+       rm -f linenoise_example linenoise_utf8_example linenoise-ship.c *.o
+
+ship: linenoise-ship.c
+
+# 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
+
+linenoise-ship.c: stringbuf.h stringbuf.c utf8.h utf8.c linenoise.c
+       cat $^ >$@

diff --git a/README.markdown b/README.markdown
index cf7e10e4dc41668c79ec356c1908c080def974b8..70cba8b32eb3364d6d96e88f45883a91d789eca0 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -8,6 +8,25 @@
 - 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?