Pull demo into jar
[nikiroo-utils.git] / src / jexer / package-info.java
... / ...
CommitLineData
1/*
2 * Jexer - Java Text User Interface
3 *
4 * License: LGPLv3 or later
5 *
6 * This module is licensed under the GNU Lesser General Public License
7 * Version 3. Please see the file "COPYING" in this directory for more
8 * information about the GNU Lesser General Public License Version 3.
9 *
10 * Copyright (C) 2015 Kevin Lamonte
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 3 of
15 * the License, or (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this program; if not, see
24 * http://www.gnu.org/licenses/, or write to the Free Software
25 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
26 * 02110-1301 USA
27 *
28 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
29 * @version 1
30 */
31
32/**
33 * Jexer - Java Text User Interface library
34 *
35 * <p>
36 * This library is currently in design, but when finished it is intended to
37 * implement a text-based windowing system loosely reminiscient of Borland's
38 * <a href="http://en.wikipedia.org/wiki/Turbo_Vision">Turbo Vision</a>
39 * library.
40 *
41 * <p>
42 * The library is currently under initial development, usage patterns are
43 * still being worked on. Generally the goal will be to build applications
44 * somewhat as follows:
45 *
46 * <p>
47 * <pre>
48 * {@code
49 * import jexer.*;
50 *
51 * public class MyApplication extends TApplication {
52 *
53 * public MyApplication() {
54 * super();
55 *
56 * // Create an editor window that has support for copy/paste,
57 * // search text, arrow keys, horizontal and vertical scrollbar, etc.
58 * addEditor();
59 *
60 * // Create standard menus for File and Window
61 * addFileMenu();
62 * addWindowMenu();
63 * }
64 *
65 * public static void main(String [] args) {
66 * MyApplication app = new MyApplication();
67 * app.run();
68 * }
69 * }
70 * }
71 * </pre>
72 */
73package jexer;