Updated READMEs

Change-Id: I60eb78fcf7eab53771c12687b0b973ea732ebf1c

README.md

@@ -5,73 +5,39 @@ Vaadin
 For instructions about _using_ Vaadin to develop applications, please refer to
 https://vaadin.com/learn
 
-To contribute, first refer to https://vaadin.com/wiki/-/wiki/Main/Contributing+Code
+To contribute, first refer to [Contributing Code](https://vaadin.com/wiki/-/wiki/Main/Contributing+Code)
 for general instructions and requirements for contributing code to the Vaadin framework.
 
-Instructions on how to set up a working environment for developing the Vaadin
+Instructions on how to set up a working environments for developing the Vaadin
 framework follow below.
 
-Quick Setup
+Eclipse Quick Setup
 ======
-1. <code>git clone https://github.com/vaadin/vaadin.git</code>
-1. Install IvyDE, including Ant Tasks, if needed (http://www.apache.org/dist/ant/ivyde/updatesite)
-1. Import the project into Eclipse
-1. Run build/ide.xml in Eclipse
-
-For more details, see below
-
-Cloning the project repositories
-======
-The Vaadin repository can be cloned using
-<pre><code>git clone https://github.com/vaadin/vaadin.git</code></pre>
-
-or using your favorite Git tool.
-
+1. Run
+<code>git clone https://github.com/vaadin/vaadin.git</code>
+command or clone the repository your favorite Git tool.
 If using Windows, you might want to add these Git settings: `core.autocrlf=false` and `core.fileMode=false`.
-
-Setting up Eclipse to Develop Vaadin 7
-=========
-
-Start Eclipse
--------------
-Start Eclipse with the workspace you would like to use. It is usually a good idea to use the parent folder of the Git repository as the workspace folder.
-
-Install IvyDE
----------
-You'll need the Apache Ivy plug-in for Eclipse to build the project:
-
-1. Go to *Help* -> *Install New Software...*
-1. Enter `http://www.apache.org/dist/ant/ivyde/updatesite` in the "Work with:" text field
-1. Select and install all items
-
-If you have installed IvyDE via the Eclipse Marketplace previously, **make sure** that you also have *Apache Ivy Ant Tasks* installed, which is not included in that IvyDE installation:
-
-1. Go to *Help* -> *Install New Software...*
-1. Click the hyperlink in the "What is already installed?" sentence near the bottom right-hand corner
-1. Verify that the list includes *Apache Ivy Ant Tasks*
-1. If it isn't included, follow the installation process above, but select only *Apache Ivy library* > *Apache Ivy Ant Tasks*
-
-
-Import the Project into the Workspace
-------------
-1. Do *File* -> *Import* -> *General* -> *Existing Projects into Workspace*
-![ImportProject](http://f.cl.ly/items/0G361519182v1z2T1o1O/Import.png "Import project")
+1. Run <code>mvn install</code> in the project root.
+Note that the first compilation takes a while to finish as maven downloads dependencies used in the projects.
+1. Start Eclipse with the workspace you would like to use. It is usually a good idea to use the parent folder of the Git repository as the workspace folder.
+1. Import the project into Eclipse as a maven project. Use *File* -> *Import* -> *Maven* -> *Existing Maven Projects*.
 1. Select the *vaadin* folder (where you cloned the project)
-1. Ensure the *vaadin* project is checked
-1. Click “finish” to complete the import of Vaadin Framework
+1. Click “Finish” to complete the import of Vaadin Framework
 
-The project should compile without further configuration. If the project does not compile without errors, choose *Ivy* -> *Resolve* from the vaadin project popup menu to ensure all dependencies have been resolved.
+Now the project should compile without further configuration.
 
-Note that the first compilation takes a while to finish as Ivy downloads dependencies used in the projects.
 
 Compiling the Default Widget Set and Themes
 --------
-Compile the default widget set by executing the default target in build/ide.xml in the vaadin project.
-In Eclipse this is done by opening build/ide.xml, right clicking on it and choosing *Run As* -> *Ant Build*.
-![CompileWidgetSet](http://cl.ly/image/1R43162b282e/build.png "Compiling the Widget Set")
+* Compile the default widgetset by running <code>install</code> maven goal in `vaadin-client-compiled` module root.
+In Eclipse this is done by right clicking on vaadin-client-compiled project it and choosing *Run As* -> *Maven Build...*.
+* Compile the default themes by running <code>install</code> maven goal in `vaadin-themes` module root.
+In Eclipse this is done by right clicking on vaadin-themes project it and choosing *Run As* -> *Maven Build...*.
 
 Set up extra workspace preferences
 --------
+TODO check if it's relevant
+=====
 The following preferences need to be set to keep the project consistent. You need to do this especially to be able to contribute changes to the project.
 
 1. Open *Window* -> *Preferences* (Windows) or *Eclipse* -> *Preferences* (Mac)
@@ -90,29 +56,53 @@ Indentation size: 4
 
 Running a UI test
 ------
+TODO
+=====
 The *vaadin* project includes an embedded Jetty (*com.vaadin.launcher.DevelopmentServerLauncher*) which is used for running the UI tests.
 In Eclipse you can launch it using the included launch configuration: Right click on *eclipse/Development Server (vaadin).launch" and select *Debug As* -> *Development Server (vaadin)*.
 
 This launches a Jetty on port 8888 which allows you to run any UI class in the project by opening http://localhost:8888/run/&lt;UI class name&gt;?restartApplication in your browser, e.g. [http://localhost:8888/run/com.vaadin.tests.components.label.LabelModes?restartApplication](http://localhost:8888/run/com.vaadin.tests.components.label.LabelModes?restartApplication) (Use ?restartApplication to ensure the correct UI is shown).
 
-Running JUnit tests
+Building a package
 =====
-The unit tests for the projects can be run using
-<pre><code>ant test</code></pre>
+The distribution files can be built by running maven goal
+<pre><code>maven clean install</code></pre>
+in the project root directory.
 
-Note that the included Vaadin TestBench (browser) tests require access to a TestBench cluster, currently only available internally at Vaadin Ltd.
+To use a specific version number, modify <code>&lt;version&gt;</code> tag in root pom.xml file.
+This goal runs all project tests TestBench tests, which require access to a a TestBench cluster, currently only available internally at Vaadin Ltd.
 
-Building a package
+Running TestBench tests
 =====
-The distribution files can be built in two steps.
-
-1. Unpack required gwt jars into the project
-<pre><code>ant -f gwt-files.xml unpack.gwt</code></pre>
-2. Build the project by running
-<pre><code>ant</code></pre>
-in the project root directory (add -Dvaadin.version=1.2.3 to use a specific version number).
+TODO
+=====
+The unit tests for the projects can be run using
+<pre><code>ant test</code></pre>
 
-Setting up other IDEs to Develop Vaadin 7
+Setting up IntelliJ IDEA to Develop Vaadin 7
 =========
+1. Intall and run IDEA. Ultimate Edition is better but Community Edition should also work.
+1. Ensure if Git and Maven plugins are installed, properly configured and enabled.
+1. Formatting settings _TODO_
+1. Clone the repository, using menu VCS -> Checkout from Version Control -> Git -> Git Repository URL -> https://github.com/vaadin/vaadin.git.
+  When the repository is cloned, do **NOT** open it as a project.
+1. Open cloned repository as a maven object. Use File -> Open and choose root _pom.xml_ file
+1. Have a coffee break while IDEA is loading dependencies and indexing the project
+1. Use Maven tool window to compile modules and the whole project
+1. Run UI tests
+ 1. Open *File* -> *Project Structure* -> *vaadin-uitest*
+ 1. Click *Dependencies* tab
+ 1. Click green *+* -> *Library...*
+ 1. From project libraries select *Maven: com.vaadin.external.gwt:gwt-** and click *Add selected*
+ 1. Compile default themes and widgetset (see above)
+ 1. Click *Run* -> *Edit Configurations...* -> Green *+* -> *Application*
+ 1. Set *Main class* into `com.vaadin.launcher.DevelopmentServerLauncher`, *Working dir* into `$MODULE_DIR$`,
+*Use classpath of module* into `vaadin-uitest` and click *Apply*. Now you have a run configuration for UI tests
+
+
+1. Run SuperDev mode _TODO_
+
+TODO remove following & ask Sauli to add a notification about outdated instructions
+=============
 - Unofficial instructions
   - IntelliJ IDEA: http://github.com/Saulis/vaadin-idea-workspace/

all/src/main/resources/WebContent/README.TXT

@@ -1,13 +1,25 @@
 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 lib/*.jar to WEB-INF/lib in your project
-3. 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.
+1. Copy following files from the archive root into WEB-INF/lib in your project:
+   - vaadin-server-*.jar
+   - vaadin-shared-*.jar
+   - vaadin-themes-*.jar
+   - vaadin-push-*.jar (if you need push)
 
-If you are using Eclipse and a standard WTP (Dynamic Web Project or Vaadin Project), step 3 can be:
-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.
+2. Copy following files from the archive /lib into WEB-INF/lib in your project:
+   - vaadin-slf4j-jdk14-*.jar
+   - flute-*.jar
+   - guava-*.jar
+   - js-*.jar
+   - jsoup-*.jar
+   - sac-*.jar
+   - streamhtmlparser-jsilver-*.jar
+   - atmosphere-runtime-*.jar  (if you need push)
 
+3. 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.
+
+4. Read https://vaadin.com/docs/-/part/framework/application/application-overview.html#application.overview to start your development