diff options
| author | Marko Grönroos <magi@iki.fi> | 2010-01-11 14:16:33 +0000 |
|---|---|---|
| committer | Marko Grönroos <magi@iki.fi> | 2010-01-11 14:16:33 +0000 |
| commit | 59d31a7a5b96d9d7dfb6c9e56cf92c3864031b12 (patch) | |
| tree | 65df76cadc7bd0264ce616ccf6135a8a4bf9d39d /build/package/readme.txt | |
| parent | 01f3db6a300a7c36aafc9687aeeff27700caf2a1 (diff) | |
| download | vaadin-framework-59d31a7a5b96d9d7dfb6c9e56cf92c3864031b12.tar.gz vaadin-framework-59d31a7a5b96d9d7dfb6c9e56cf92c3864031b12.zip | |
Updated build scripts to build only one platform-independent package (#3811). Updated sample widgetset build script for GWT 2.0 (#3972). Also removed obsolete Mac DMG target.
svn changeset:10679/svn branch:6.3
Diffstat (limited to 'build/package/readme.txt')
| -rw-r--r-- | build/package/readme.txt | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/build/package/readme.txt b/build/package/readme.txt new file mode 100644 index 0000000000..d8c3d8ca77 --- /dev/null +++ b/build/package/readme.txt @@ -0,0 +1,79 @@ +==============================================================================
+Vaadin @version@ Readme
+==============================================================================
+
+-------------
+How to Start?
+-------------
+
+In Windows:
+ Just double-click start.bat icon. It will start a web application at
+ port 8888 on the local host and opens a web browser window to display
+ the start page of Vaadin Content Browser.
+
+In Linux:
+ Open a shell window, change to the installation directory, and execute
+ "sh start.sh". It will start a web application at port 8888 on the local
+ host and opens a web browser window to display the start page of Vaadin
+ Content Browser.
+
+In Mac:
+ Start Terminal.app and run the start.sh script in the installation
+ directory. It will start a web application at port 8888 on the local
+ host and opens a web browser window to display the start page of Vaadin
+ Content Browser.
+
+The installation directory is a web application as itself and can be directly
+imported to the Eclipse IDE by selecting
+"File / Import / Existing Projects into Workspace" from Eclipse main menu.
+See the manual for detailed instructions.
+
+---------------------------------
+What's Inside the Vaadin Package?
+---------------------------------
+
+You should start exploring Vaadin through the provided Content Browser web
+application within this package; see 'How to Start?' above.
+
+The WebContent directory contains the content available through the Content
+Browser: the Vaadin Library, demos, documentation, and other useful
+information to get started with Vaadin.
+
+Below is a list of most important locations and files:
+
+Start Vaadin
+- start exploring Vaadin by double-clicking this icon
+
+COPYING
+- license file
+
+WebContent/vaadin-@version@.jar
+- Vaadin Library containing Java source and compiled files
+
+WebContent/doc/book-of-vaadin.pdf
+- Book of Vaadin in PDF format
+
+WebContent/doc/api/index.html
+- Vaadin API Documentation as JavaDoc reference
+
+WebContent/WEB-INF/src
+- Content Browser source code, compiled into WebContent/WEB-INF/classes
+
+WebContent/doc/example-source
+- example source code in HTML format
+
+WebContent/demo
+- files required by the demos
+
+Vaadin Hosted Mode Browser.launch
+Vaadin Development Server.launch
+- launch configurations for Eclipse workspace
+
+WebContent/doc/example-source/build-widgetset.xml
+- example on how to build GWT widget sets for Vaadin application
+
+WebContent/VAADIN
+- widget sets and themes
+
+gwt
+- Google Web Toolkit is required for building new widget sets
|