]> source.dussan.org Git - vaadin-framework.git/commitdiff
better readmes
authorJani Laakso <jani.laakso@itmill.com>
Mon, 3 Dec 2007 11:43:54 +0000 (11:43 +0000)
committerJani Laakso <jani.laakso@itmill.com>
Mon, 3 Dec 2007 11:43:54 +0000 (11:43 +0000)
svn changeset:3109/svn branch:trunk

build/package/linux-readme.txt
build/package/win-readme.txt

index 931a7da0b4be473d5ad8f9da5569f80fd7dddacd..60a27b0bebe57db1aa2625ab014d2efa2bc8f7a0 100644 (file)
@@ -1,7 +1,54 @@
-== How to start ==\r
+== IT Mill Toolkit <version></version> Readme ==\r
 \r
-Open shell and execute "sh start.sh".\r
+How to Start?\r
 \r
-This starts an integrated Servlet Container (Jetty) which runs index page\r
-and Toolkit demo applications. Your default web browser should be opened\r
-automatically.\r
+Open shell and execute "sh start.sh". IT Mill Toolkit webpage guides you forward.\r
+\r
+\r
+What's Inside the IT Mill Toolkit Package?\r
+\r
+You should explore package through the provided webpage within the package,\r
+see 'How to Start?' above. Package is an web application itself and directly\r
+importable to Eclipse IDE.\r
+\r
+Here are few important locations and files:\r
+\r
+Start\r
+- start exploring IT Mill Toolkit by double-clicking this icon\r
+\r
+WebContent/License\r
+- license files\r
+\r
+WebContent/WEB-INF/lib/itmill-toolkit-<version></version>.jar\r
+- IT Mill Toolkit library containing sources and compiled files\r
+\r
+WebContent/demo/itmill-toolkit.war\r
+- deployable demo application for your application server\r
+\r
+WebContent/doc/manual.pdf\r
+- manual in PDF format\r
+\r
+WebContent/doc/manual/index.html\r
+- manual in HTML format\r
+\r
+WebContent/doc/api/index.html\r
+- JavaDocs\r
+\r
+WebContent/WEB-INF/src\r
+- demo source code, compiled into WebContent/WEB-INF/classes\r
\r
+WebContent/doc/example-source\r
+- example source in HTML format\r
+\r
+WebContent/demo\r
+- files required by demos\r
+\r
+IT Mill Toolkit Hosted Mode.launch\r
+IT Mill Toolkit Web Mode.launch\r
+- launch configurations for Eclipse workspace\r
+\r
+build-widgetsets.xml\r
+- builds GWT widgetsets for IT Mill Toolkit applications\r
+\r
+WebContent/ITMILL\r
+- widgetsets and themes\r
index bf890924276ca722d197104e39b5335eacacf440..11a261b4eb54c1b2ce4d02fc75c9b7e801e87545 100644 (file)
@@ -1,7 +1,54 @@
-== How to start ==\r
+== IT Mill Toolkit <version></version> Readme ==\r
 \r
-Double-click start.bat.\r
+How to Start?\r
 \r
-This starts an integrated Servlet Container (Jetty) which runs index page\r
-and Toolkit demo applications. Your default web browser should be opened\r
-automatically.\r
+Double-click start.bat. IT Mill Toolkit webpage guides you forward.\r
+\r
+\r
+What's Inside the IT Mill Toolkit Package?\r
+\r
+You should explore package through the provided webpage within the package,\r
+see 'How to Start?' above. Package is an web application itself and directly\r
+importable to Eclipse IDE.\r
+\r
+Here are few important locations and files:\r
+\r
+Start\r
+- start exploring IT Mill Toolkit by double-clicking this icon\r
+\r
+WebContent/License\r
+- license files\r
+\r
+WebContent/WEB-INF/lib/itmill-toolkit-<version></version>.jar\r
+- IT Mill Toolkit library containing sources and compiled files\r
+\r
+WebContent/demo/itmill-toolkit.war\r
+- deployable demo application for your application server\r
+\r
+WebContent/doc/manual.pdf\r
+- manual in PDF format\r
+\r
+WebContent/doc/manual/index.html\r
+- manual in HTML format\r
+\r
+WebContent/doc/api/index.html\r
+- JavaDocs\r
+\r
+WebContent/WEB-INF/src\r
+- demo source code, compiled into WebContent/WEB-INF/classes\r
\r
+WebContent/doc/example-source\r
+- example source in HTML format\r
+\r
+WebContent/demo\r
+- files required by demos\r
+\r
+IT Mill Toolkit Hosted Mode.launch\r
+IT Mill Toolkit Web Mode.launch\r
+- launch configurations for Eclipse workspace\r
+\r
+build-widgetsets.xml\r
+- builds GWT widgetsets for IT Mill Toolkit applications\r
+\r
+WebContent/ITMILL\r
+- widgetsets and themes\r