Updated project setup instructions and Eclipse formatting instructions. (#12001)

1 files changed, 12 insertions, 84 deletions

diff --git a/README.md b/README.md
index 588449a09a..c6d7f31b5f 100644
--- a/README.md
+++ b/README.md
@@ -2,97 +2,25 @@
 
 # Vaadin Framework
 
-*[Vaadin Framework](https://vaadin.com/framework) allows you to build modern web apps efficiently in plain Java, without touching low level web technologies.*
+*[Vaadin](https://vaadin.com) allows you to build modern web apps efficiently in plain Java, without touching low level web technologies.*
 
-For instructions about _using_ Vaadin to develop applications, please refer to [Vaadin tutorial](https://vaadin.com/docs/-/part/framework/tutorial.html) and other [documentation](https://vaadin.com/docs/).
+This repository contains source code and issue tracking for Vaadin 8 and Vaadin 7, both of which use GWT as the base of client-side implementations. You can find source code and issue tracking for newer, web component based Vaadin versions in [vaadin/platform](https://github.com/vaadin/platform).
 
-To contribute, first refer to [Contributing Code](https://github.com/vaadin/framework/blob/master/CONTRIBUTING.md)
-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 Framework follow below.
-
-## Building a package
-
-The distribution files can be built by running the standard Maven goal `mvn install` in the project root.
-
-## Eclipse Quick Setup
-
-1. Run
-<code>git clone https://github.com/vaadin/framework.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`, `core.fileMode=false` and `core.longpaths=true`.
-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 *framework* folder (where you cloned the project)
-1. Click “Finish” to complete the import of Vaadin Framework
-
-Now the project should compile without further configuration.
-
-### Compiling the Default Widget Set and Themes
-
-* 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
+Vaadin 8 includes Vaadin 7 compatibility classes and is supported until February 21, 2022 (extended support will be available for ten years after that).
 
-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.
+Vaadin 7 support has already ended, [extended support](https://vaadin.com/support/vaadin-7-extended-maintenance) is available until February 2029.
 
-1. Open *Window* -> *Preferences* (Windows) or *Eclipse* -> *Preferences* (Mac)
-1. Go to *General* ->  *Workspace*
- 1. Set *Text file encoding* to *UTF-8*
- 1. Set *New text file line delimiter* to *Unix*
-1. Go to XML -> XML Files -> Editor
- 1. Ensure the settings are follows:
+## Using Vaadin 8 to develop applications
 
-  * Line width: 72
-  * Format comments: true
-  * Join lines: true
-  * Insert whitespace before closing empty end-tags: true
-  * Indent-using spaces: true
-  * Indentation size: 4
+Please refer to [Vaadin tutorial](https://vaadin.com/docs/v8/framework/tutorial.html) and other [documentation](https://vaadin.com/docs/v8/index.html).
 
+For known issues within Vaadin framework, see [Issue Tracker](https://github.com/vaadin/framework/issues). Comment or react to an existing issue to mark your interest in resolving it. If you don't find an existing report of an issue you are experiencing, [submit a new issue](https://github.com/vaadin/framework/issues/new/choose).
 
-### Running a UI test
+## Contributing
 
-1. In a Project Explorer  right-click *vaadin-uitest*
-1. Open *Run As* -> *Maven build...*
-1. Type in <code>jetty:run-exploded</code> into *Goals* and click *Run*
-1. Open URL [http://localhost:8888/run/&lt;testUI&gt;](http://localhost:8888/run/<testUI>)
-
-For full instructions please visit [README-TESTS.md](README-TESTS.md).
-
-## Setting up IntelliJ IDEA to Develop Vaadin Framework 8
-
-1. Install 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. Clone the repository, using menu VCS -> Checkout from Version Control -> Git -> Git Repository URL -> https://github.com/vaadin/framework.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. Run Maven targets <code>clean</code> and <code>install</code> using *Maven Projects* tool window to compile the whole project
-
-### Running a specific UI test
-
-1. Open *Maven Projects*
-1. Open *vaadin-uitest* -> *Plugins* -> *jetty* -> *jetty:run-exploded*
-1. Open URL [http://localhost:8888/run/&lt;testUI&gt;](http://localhost:8888/run/<testUI>)
-
-For full instructions please visit [README-TESTS.md](README-TESTS.md).
-
-### Running a Development Server
-
-1. Open *Run* menu  and click *Edit Configurations*
-1. Click green ***+*** sign at top left corner, select *Maven* from popup
-1. In the run configuration page, set any name for the configuration, select *vaadin-uitest* project folder as *Working directory*
-1. Type <code>exec:exec@run-development-server</code> into *Command line* and save the configuration
-1. Run the configuration and open URL [http://localhost:8888/run/&lt;testUI&gt;](http://localhost:8888/run/<testUI>)
+To contribute, first refer to [Contributing Code](CONTRIBUTING.md)
+for general instructions and requirements for contributing code to the Vaadin framework.
 
-### Running a Development Server in a debug mode
+For instructions on how to set up a working environment for developing the Vaadin framework, please visit [Development Instructions](README-DEV.md). Pay special attention to workspace preferences.
 
-1. Type <code>exec:exec@debug-development-server</code> into *Command line* and save the configuration
-1. In the same dialog, create new "Remote" debug configuration, using *localhost* and *Port 5005*
-1. Start both configurations and open URL [http://localhost:8888/run/&lt;testUI&gt;](http://localhost:8888/run/<testUI>)
+We appreciate all contributors and want to make submitting changes as easy as possible. If you find any mistakes, unclear parts or out-of-date instructions, please let us know by submitting an issue or a pull request.