summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--build/package/mac-readme.txt60
1 files changed, 54 insertions, 6 deletions
diff --git a/build/package/mac-readme.txt b/build/package/mac-readme.txt
index bdd0e9d782..bf2c507fc5 100644
--- a/build/package/mac-readme.txt
+++ b/build/package/mac-readme.txt
@@ -1,8 +1,56 @@
-== How to start ==
+== IT Mill Toolkit <version></version> Readme ==
-Double-click icon Start.
-Or open shell and execute "sh start.sh".
+How to Start?
-This starts an integrated Servlet Container (Jetty) which runs index page
-and Toolkit demo applications. Your default web browser should be opened
-automatically.
+Just double-click icon Start. IT Mill Toolkit webpage guides you forward.
+If for some reason Start icon fails in your environment, another option is
+to open shell and execute "sh start.sh".
+
+
+What's Inside the IT Mill Toolkit Package?
+
+You should explore package through the provided webpage within the package,
+see 'How to Start?' above. Package is an web application itself and directly
+importable to Eclipse IDE.
+
+Here are few important locations and files:
+
+Start
+- start exploring IT Mill Toolkit by double-clicking this icon
+
+WebContent/License
+- license files
+
+WebContent/WEB-INF/lib/itmill-toolkit-<version></version>.jar
+- IT Mill Toolkit library containing sources and compiled files
+
+WebContent/demo/itmill-toolkit.war
+- deployable demo application for your application server
+
+WebContent/doc/manual.pdf
+- manual in PDF format
+
+WebContent/doc/manual/index.html
+- manual in HTML format
+
+WebContent/doc/api/index.html
+- JavaDocs
+
+WebContent/WEB-INF/src
+- demo source code, compiled into WebContent/WEB-INF/classes
+
+WebContent/doc/example-source
+- example source in HTML format
+
+WebContent/demo
+- files required by demos
+
+IT Mill Toolkit Hosted Mode.launch
+IT Mill Toolkit Web Mode.launch
+- launch configurations for Eclipse workspace
+
+build-widgetsets.xml
+- builds GWT widgetsets for IT Mill Toolkit applications
+
+WebContent/ITMILL
+- widgetsets and themes