From: Jani Laakso <jani.laakso@itmill.com>
Date: Mon, 3 Dec 2007 11:43:54 +0000 (+0000)
Subject: better readmes
X-Git-Tag: 6.7.0.beta1~5330
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a333f421532b6b2925f19a24d8f35638a39b7e96;p=vaadin-framework.git

better readmes

svn changeset:3109/svn branch:trunk
---

diff --git a/build/package/linux-readme.txt b/build/package/linux-readme.txt
index 931a7da0b4..60a27b0beb 100644
--- a/build/package/linux-readme.txt
+++ b/build/package/linux-readme.txt
@@ -1,7 +1,54 @@
-== How to start ==
+== IT Mill Toolkit <version></version> Readme ==
 
-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.
+Open shell and execute "sh start.sh". IT Mill Toolkit webpage guides you forward.
+
+
+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
diff --git a/build/package/win-readme.txt b/build/package/win-readme.txt
index bf89092427..11a261b4eb 100644
--- a/build/package/win-readme.txt
+++ b/build/package/win-readme.txt
@@ -1,7 +1,54 @@
-== How to start ==
+== IT Mill Toolkit <version></version> Readme ==
 
-Double-click start.bat.
+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.
+Double-click start.bat. IT Mill Toolkit webpage guides you forward.
+
+
+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