0fbe69e Update bundle readme.
src/README.TXT (gone) | 119 --------------------
src/readme.txt (new) | 76 +++++++++++++
2 files changed, 76 insertions(+), 119 deletions(-)
diff --git a/src/README.TXT b/src/README.TXT
deleted file mode 100644
index 6c01768..0000000
--- a/src/README.TXT
+++ /dev/null
@@ -1,119 +0,0 @@
-Lucee on Jetty
-
-
-Description
------------
-
-Lucee on Jetty is an unzip-and-run Lucee-enabled Jetty server. It does not
-require installation, simply extract the files from the zip and run the
-start-server script and you have a server running Lucee.
-
-The file structure uses Jetty's home/base directory split - this means:
-* The directory jetty-home is an unmodified copy of the latest Jetty release.
-* The directory lucee-base contains the Lucee JAR and configuration.
-(See readme file in lucee-base for further details.)
-
-This bundle was created from the template at:
-
- https://github.com/boughtonp/lucee-on-jetty
-
-
-Usage
------
-
-Unzip to a suitable location.
-On Windows, double-click the start-server.bat to start the server.
-All other operating systems, execute start-server.sh to start the server.
-Pressing Ctrl-C will shutdown the server.
-
-There are README files in many directories. Reading them is highly recommended.
-
-Key points:
-* The default port (8080) can be changed in lucee-base/start.ini
-* The default webroot is lucee-base/webapps/ROOT
-* Instructions for adding more are in lucee-base/webapps/readme.md
-* The Lucee web admin for a context is at http://{hostname}/lucee/admin/web.cfm
-and the context directories are at lucee-base/webinfs/{lucee-context-label}
-* The Lucee server admin is http://{hostname}/lucee/admin/server.cfm and the
-server context can be found in lucee-base/lucee-server
-
-
-Licensing
----------
-
-This Lucee on Jetty bundle is collectively licensed as LGPLv3, with its included
-documentation licensed as CC-BY-SA v4.0.
-
-The primary components are licensed as below. These in turn have their own
-components - see respective READMEs for details.
-
-Jetty v{JETTY_VERSION}
-* Website: http://eclipse.org/jetty
-* Source: http://git.eclipse.org/c/jetty
-* License: Apache v2.0 (also available under EPL v2)
-* Files: jetty-home/*
-
-Lucee v{LUCEE_VERSION}
-* Website: http://lucee.org
-* Source: https://bitbucket.org/lucee/lucee
-* License: LGPLv2
-* Files: lucee-base/modules/lucee/lib/lucee*.jar
-
-
-
-FAQ
----
-
-> What port does it run on?
-
-The HTTP server will run on the port specified by the `jetty.http.port` setting in
-the lucee-base/start.ini config file, and uses the Jetty default of 8080. It can
-be changed to any available port. Note that changes to start.ini require a Jetty
-restart to be picked up.
-
-> Where is the hostname/aliases set?
-
-Jetty runs on localhost only by default, but can be set to respond to any IP or
-hostname. This is configured on a per-context basis, e.g. each host can have its
-own context, or multiple virtual host aliases can point to a single context.
-
-The configuration for this is via the webapp context XML config files, which
-reside in lucee-base/webapps - see the associated readme for further details.
-
-> Where is the webroot?
-
-The default webroot is lucee-base/webapps/ROOT/
-You can add virtual host aliases by editing lucee-base/webapps/ROOT.xml
-You can add other webroots (contexts) by copying and changing the XML file.
-
-See the readme in lucee-base/webapps for details of both of these.
-
-> Where are the Lucee logs?
-
-Lucee logs are stored in a context's web config directory - that is in
-lucee-base/webinfs/{web-context-label}/logs
-(The web-context-label defaults to a unique value for each context. To see - and
-change - this label, for all contexts, login to the Lucee Server Admin.)
-
-The logs directory in lucee-base is used by the Jetty instance.
-
-> How is Jetty upgraded?
-
-Download a new Jetty distribution and replace the jetty-home directory with it.
-
-> How is Lucee upgraded?
-
-Use Lucee's own upgrade functionality (i.e. via admin, or an lco patch file).
-For major upgrades, replace the JAR in lucee-base/modules/lucee/lib/ with a
-new Lucee JAR download.
-
-> I have a question not answered here?
-
-Check the documentation:
- https://docs.sorcerersisle.com/luje
-
-If the answer is not there, raise an issue:
- https://github.com/boughtonp/lucee-on-jetty/issues
-
-
-/eof
\ No newline at end of file
diff --git a/src/readme.txt b/src/readme.txt
new file mode 100644
index 0000000..3a4ee7f
--- /dev/null
+++ b/src/readme.txt
@@ -0,0 +1,76 @@
+Lucee on Jetty
+
+
+Description
+-----------
+
+Lucee on Jetty is an unzip-and-run Lucee-enabled Jetty server. It does not
+require installation, simply extract the files from the zip, run the
+start-server script, and you have a Jetty server running Lucee.
+
+The file structure uses Jetty's home/base directory split - this means:
+* The directory jetty-home is an unmodified copy of the latest Jetty release.
+* The directory lucee-base contains all configuration and the Lucee JAR.
+
+Documentation is provided in docs.pdf and online at https://docs.sorcerersisle.com/luje
+
+This bundle was built using the template at https://code.sorcerersisle.com/luje
+
+
+Requirements
+------------
+
+The requirements for running a Lucee on Jetty bundle are that of the
+individual components - namely, a supported Java VM.
+
+For Jetty 9.x and Lucee 5.x this means a JRE at v8 or v11.
+
+Jetty 10.x requires a v11 JRE.
+
+If in doubt, visit https://adoptopenjdk.net and follow the instructions
+to get the latest OpenJDK 11 (LTS) for your operating system.
+
+
+Usage
+-----
+
+Unzip to a suitable location.
+On Windows, double-click the start-server.bat to start the server.
+All other operating systems, execute start-server.sh to start the server.
+Pressing Ctrl-C will shutdown the server.
+
+Browse to http://localhost:8080/ to confirm it is working.
+
+See docs.pdf for details of what is configured, what the various files and
+directories are for, etc.
+
+Quick points:
+* The default webroot is lucee-base/webapps/ROOT
+* The default port (8080) can be changed in lucee-base/start.ini
+* The Lucee web admin for a context is at http://{hostname}/lucee/admin/web.cfm
+and the context directories are at lucee-base/webinfs/{lucee-context-label}
+* The Lucee server admin is http://{hostname}/lucee/admin/server.cfm and the
+server context can be found in lucee-base/lucee-server
+
+
+Licensing
+---------
+
+This Lucee on Jetty bundle is collectively licensed as LGPLv3.
+
+The primary components are licensed as below. These in turn have their own
+components - see respective READMEs for details.
+
+Jetty v{JETTY_VERSION}
+* Website: https://eclipse.org/jetty
+* Source: https://github.com/eclipse/jetty.project
+* License: Apache v2.0 (also available under EPL v2)
+* Files: jetty-home/*
+
+Lucee v{LUCEE_VERSION}
+* Website: https://www.lucee.org
+* Source: https://bitbucket.org/lucee/lucee
+* License: LGPLv2
+* Files: lucee-base/modules/lucee/lucee*.jar lucee-base/lucee-server/*
+
+
