cmdline: new build system

[libcmdline.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..150f0cd
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+This library provides an interface to implement command line
+interfaces. It has no dependency except libc, and it contains its own
+(lightweight) alternative to readline. The libcmdline library was
+initially designed for very small devices like microcontrollers or
+embedded devices running outside an OS, but it also fully works under
+linux.
+
+To compile:
+  make
+
+Then install it:
+  make install PREFIX=/usr/local
+
+If you don't have libevent on your system, edit the libcmdline.vars.mk
+file and comment the related line.
+
+To cross-compile the library (example for powerpc):
+  make CROSS=powerpc-linux-gnu-