From 3a449bc485861e99e23fc47f54d17028e7996e86 Mon Sep 17 00:00:00 2001 From: nathan Date: Fri, 24 Oct 2014 21:22:49 +0200 Subject: [PATCH] Updated readme with more specific details --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 32fb149..5bbcde1 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,19 @@ This small library is very similar to what JLine provides, however it does 4 thi - Backspace functionality for line input is preserved. - Ctrl-C (SIGINT) is also preserved in windows 2) Uses native calls (instead of shell execution) for linux & mac terminal configuration -3) supports unsupported teminals (for example, while in an IDE ), so in.read() will still return (a line is split into chars, then fed to consumer). The enter key must still be pressed. -4) multi-threaded, intelligent buffering of command input for simultaneous input readers on different threads +3) Supports unsupported teminals (for example, while in an IDE ), so in.read() will still return (a line is split into chars, then fed to consumer). The enter key must still be pressed. +4) Multi-threaded, intelligent buffering of command input for simultaneous input readers on different threads This is for cross-platform use, specifically - linux 32/64, mac 32/64, and windows 32/64. Java 6+ ANSI output to console is also supported, and is required for backspace functionality to work when echo is enabled. +Note: If you use the attached JNA/JAnsi libraries, you MUST load the respective native libraries yourself, especially with + JNA (as the loading logic has been removed from the jar) + + +Note: This project was heavily influence by the excellent JLine library. + - JLine - BSD License + http://jline.sourceforge.net/ + Copyright 2002-2006, Marc Prud'hommeaux All rights reserved. \ No newline at end of file