oops
[fanfix.git] / src / jexer / package-info.java
1 /*
2 * Jexer - Java Text User Interface
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (C) 2019 Kevin Lamonte
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
25 *
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
27 * @version 1
28 */
29
30 /**
31 * Jexer - Java Text User Interface library
32 *
33 * <p>
34 * This library is a text-based windowing system loosely reminiscent of
35 * Borland's <a href="http://en.wikipedia.org/wiki/Turbo_Vision">Turbo
36 * Vision</a> library. Jexer's goal is to enable people to get up and
37 * running with minimum hassle and lots of polish. A very quick "Hello
38 * World" application can be created as simply as this:
39 *
40 * <pre>
41 * {@code
42 * import jexer.TApplication;
43 *
44 * public class MyApplication extends TApplication {
45 *
46 * public MyApplication() throws Exception {
47 * super(BackendType.XTERM);
48 *
49 * // Create standard menus for Tool, File, and Window.
50 * addToolMenu();
51 * addFileMenu();
52 * addWindowMenu();
53 * }
54 *
55 * public static void main(String [] args) throws Exception {
56 * MyApplication app = new MyApplication();
57 * app.run();
58 * }
59 * }
60 * }
61 * </pre>
62 */
63 package jexer;