Readme for zip (#9299)

diff --git a/all/README.TXT b/all/README.TXT
new file mode 100644 (file)
index 0000000..55685ac
--- /dev/null
+++ b/all/README.TXT
@@ -0,0 +1,13 @@
+This Vaadin zip contains all the jars of the Vaadin Framework. Additionally all dependencies are provided in the lib folder.
+
+To use in a web project:
+1. Copy all vaadin-* files except vaadin-client and vaadin-client-compiler to WEB-INF/lib in your project
+2. Copy vaadin-client and vaadin-client-compiler to a lib folder which is on your classpath but will not be deployed. These files are only needed when compiling a module (widget set) to Javascript.
+
+If you are using Eclipse and a standard WTP (Dynamic Web Project or Vaadin Project) you can do:
+1. As above
+2. Create a /lib folder, copy the files there and right click the lib folder and select "Build Path" -> "Add to Build Path".
+Once this is done, the "Compile widgetset" button provided by the Vaadin Plug-in for Eclipse will work correctly.
+
+
+

diff --git a/all/build.xml b/all/build.xml
index f69e8a0bb5d018aae10eeb9ed914ae5012a84b5a..4281a63b2f864b8068a212714eee2f7c86d46b98 100644 (file)
--- a/all/build.xml
+++ b/all/build.xml
@@ -47,6 +47,9 @@
 
                        </fileset>
                        <fileset refid="common.files.for.all.jars" />
+                       <fileset dir="${result.dir}/..">
+                               <include name="README.TXT"/>
+                       </fileset>
                </zip>
        </target>