f287251356284857947f938d56b86619a443fbe3
[fanfix.git] / README.md

Jexer - Java Text User Interface library

WARNING: THIS IS ALPHA CODE!

This library is intended to implement a text-based windowing system loosely reminiscient of Borland’s Turbo Vision library. For those wishing to use the actual C++ Turbo Vision library, see Sergio Sigala’s updated version that runs on many more platforms.

Two backends are available:

A demo application showing the existing UI controls is available via ‘java -jar jexer.jar’ or ‘java -Djexer.AWT=true -jar jexer.jar’ .

License

This project is licensed LGPL (“GNU Lesser General Public License”) version 3 or greater. See the file LICENSE for the full license text, which includes both the GPL v3 and the LGPL supplemental terms.

Acknowledgements

Jexer makes use of the Terminus TrueType font made available here .

Usage

Usage patterns are still being worked on, but in general the goal will be to build applications somewhat as follows:

```Java import jexer.*;

public class MyApplication extends TApplication {

public MyApplication() {
    super();

    // Create standard menus for File and Window
    addFileMenu();
    addWindowMenu();
}

public static void main(String [] args) {
    MyApplication app = new MyApplication();
    app.run();
}

} ```

See the file demos/Demo1.java for detailed examples.

Roadmap

Many tasks remain before calling this version 1.0:

0.0.2:

0.0.3:

0.0.4:

0.1.0:

Wishlist features (2.0):