From ba9e3bebba152b326a964a2abffef2207b37c76b Mon Sep 17 00:00:00 2001 From: nathan Date: Fri, 24 Oct 2014 23:55:50 +0200 Subject: [PATCH] Updated readme with license info --- README.md | 43 ++++++++++++++++++++++++++++++++----------- 1 file changed, 32 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 41f42ec..f8da835 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,47 @@ Unbuffered input on the console for java applications. This small library is very similar to what JLine provides, however it does 4 things very differently: -1) Only provides unbuffered input. +1. Only provides unbuffered input. - 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 +2. Uses native calls via JNA (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. +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 +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. +ANSI output to console is also supported, and is required for backspace functionality to work if 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: 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, and includes utility + classes/methods from a variety of sources. +``` +``` +* FastObjectPool - Apache 2.0 License + http://ashkrit.blogspot.com/2013/05/lock-less-java-object-pool.html + https://github.com/ashkrit/blog/tree/master/FastObjectPool + Copyright 2013 Ashkrit -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 +* JLine - BSD License + http://jline.sourceforge.net/ + Copyright 2002-2006, Marc Prud'hommeaux All rights reserved. + +* Jansi - Apache 2.0 License + hawtjni - EPL v1.0 + https://github.com/fusesource/jansi + Copyright Hiram Chirino + +* JNA - Apache 2.0 License + https://github.com/twall/jna + Copyright (c) 2011 Timothy Wall +``` \ No newline at end of file