Skip to content

Commit

Permalink
adjust readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jdillon committed Apr 25, 2017
1 parent 42ceb00 commit 4fbd805
Showing 1 changed file with 8 additions and 14 deletions.
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,29 @@
http://www.opensource.org/licenses/bsd-license.php
-->
Description
-----------
# Description

JLine is a Java library for handling console input. It is similar in functionality to [BSD editline](http://www.thrysoee.dk/editline/) and [GNU readline](http://www.gnu.org/s/readline/) but with additional features that bring it in par with [ZSH line editor](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html). People familiar with the readline/editline capabilities for modern shells (such as bash and tcsh) will find most of the command editing features of JLine to be familiar.

JLine 3.x is an evolution of [JLine 2.x](https://github.com/jline/jline2).

[![Build Status](https://travis-ci.org/jline/jline3.svg?branch=master)](https://travis-ci.org/jline/jline3)

License
-------
# License

JLine is distributed under the [BSD License](http://www.opensource.org/licenses/bsd-license.php), meaning that you are completely free to redistribute, modify, or sell it with almost no restrictions.

Documentation
-------------
# Documentation

* [demos](https://github.com/jline/jline3/wiki/Demos)
* [wiki](https://github.com/jline/jline3/wiki)

Forums
------
# Forums

* [jline-users](https://groups.google.com/group/jline-users)
* [jline-dev](https://groups.google.com/group/jline-dev)

Maven Usage
-----------
# Maven Usage

Use the following definition to use JLine in your maven project:

Expand All @@ -58,12 +53,11 @@ JLine can also be used with more low-level jars:
<version>3.2.0</version>
</dependency>

Building
--------
# Building

### Requirements
## Requirements

* Maven 3.3+
* Maven 3.3+ (prefer included maven-wrapper)
* Java 8+

Check out and build:
Expand Down

1 comment on commit 4fbd805

@jdillon
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly to trigger travis pr change detection; as I just set that up so I had to change something

Please # to comment.