diff --git a/README.md b/README.md index ca5502d39..5d3a66099 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,40 @@ The all-new Spring Tools 4 for Eclipse, Visual Studio Code, and Theia. Learn more at https://spring.io/tools. +## Getting started + +### Installation + +Depending on your development environment, you can choose between: + +- __Spring Tools 4 for Eclipse distribution:__ a ready-to-use distribution of the latest Eclipse Desktop IDE, prepackaged with Spring Tools 4 and a few additional third-party extensions. Download, unpack, and start. +- __Spring Tools 4 for Eclipse extensions:__ you can install the Spring Tools 4 for Eclipse into an existing Eclipse Desktop IDE installation and use it from there. +- __Visual Studio Code:__ We provide extensions for Visual Studio Code if you prefer this lightweight editor for your development. +- __Eclipse Theia:__ You can install the same extensions into Theia-based environments like gitpod. + +For all those choices, you can find detailed installation instructions from the user guide: +https://github.com/spring-projects/sts4/wiki/Installation + +## User documentation + +The project wiki contains a comprehensive user documentation: +https://github.com/spring-projects/sts4/wiki + +## Ask questions + +Please ask general questions on StackOverflow and tag them with `spring-tools-4`: +https://stackoverflow.com/questions/ask?tags=spring-tools-4 + +## Raise an issue + +Please raise issues by creating a new GitHub issue at: +https://github.com/spring-projects/sts4/issues + +## Contributing + +Find details about how to contribute: +https://github.com/spring-projects/sts4/blob/master/CONTRIBUTING.adoc + ### Code of Conduct This project adheres to the Contributor Covenant [code of