Merge branch 'subtree'

[fanfix.git] / src / jexer / package-info.java

diff --git a/src/jexer/package-info.java b/src/jexer/package-info.java
index 822b28c34db2e75d82db2b75280f66d3768f92bb..300f9731a26ea9728ac27e4ef91e82f0ecbc2f34 100644 (file)
--- a/src/jexer/package-info.java
+++ b/src/jexer/package-info.java
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (C) 2016 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -31,36 +31,28 @@
  * Jexer - Java Text User Interface library
  *
  * <p>
- * This library is currently in design, but when finished it is intended to
- * implement a text-based windowing system loosely reminiscient of Borland's
- * <a href="http://en.wikipedia.org/wiki/Turbo_Vision">Turbo Vision</a>
- * library.
+ * This library is a text-based windowing system loosely reminiscent of
+ * Borland's <a href="http://en.wikipedia.org/wiki/Turbo_Vision">Turbo
+ * Vision</a> library.  Jexer's goal is to enable people to get up and
+ * running with minimum hassle and lots of polish.  A very quick "Hello
+ * World" application can be created as simply as this:
  *
- * <p>
- * The library is currently under initial development, usage patterns are
- * still being worked on.  Generally the goal will be to build applications
- * somewhat as follows:
- *
- * <p>
  * <pre>
  * {@code
- * import jexer.*;
+ * import jexer.TApplication;
  *
  * public class MyApplication extends TApplication {
  *
- *     public MyApplication() {
- *         super();
- *
- *         // Create an editor window that has support for copy/paste,
- *         // search text, arrow keys, horizontal and vertical scrollbar, etc.
- *         addEditor();
+ *     public MyApplication() throws Exception {
+ *         super(BackendType.XTERM);
  *
- *         // Create standard menus for File and Window
+ *         // Create standard menus for Tool, File, and Window.
+ *         addToolMenu();
  *         addFileMenu();
  *         addWindowMenu();
  *     }
  *
- *     public static void main(String [] args) {
+ *     public static void main(String [] args) throws Exception {
  *         MyApplication app = new MyApplication();
  *         app.run();
  *     }