diff --git a/README.md b/README.md index 657918956..4d2984555 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,43 @@ # Nebula and Opal: Rich SWT Widgets -Welcome to the Eclipse Nebula project. This repositority contains a large set of UI elements that can be used in -Fat or Thin client applications based on Java and SWT. +Welcome to the [Eclipse Nebula project](https://projects.eclipse.org/projects/technology.nebula). + +This repositority contains a large set of UI elements that can be used in fat or thin client applications based on Java and SWT. ## Download -Please have a look at https://www.eclipse.org/nebula/downloads.php +Downloads are available at the following location: +* [https://download.eclipse.org/nebula/updates/](https://download.eclipse.org/nebula/updates/) + +These sites provide both mature, stable widgets as well as incubating widgets; the latter are clearly marked as *incubating* and may break API from release to release. -You'll find update sites for all releases and also for the latest build +Refer to the [general document](https://eclipse.dev/justj/?page=tools#p2-anatomy) for details about the update site structure. ## Contact * [Issues](https://github.com/eclipse/nebula/issues) * [Questions](https://github.com/eclipse/nebula/discussions) -* [Mailing list](https://dev.eclipse.org/mailman/listinfo/nebula-dev) +* [Mailing List](https://dev.eclipse.org/mailman/listinfo/nebula-dev) ## Contribute -We can accept your patches if you have signed the [Eclipse Contributors Agreement (ECA)](https://wiki.eclipse.org/ECA) -which ensures users of these libraries that they can use your code without getting into any legal trouble. -For every patch we require a [corresponding GitHub issue.](https://github.com/eclipse/nebula/issues) +We can accept your patches if you have [properly set up an account](https://github.com/eclipse-platform/.github/blob/main/CONTRIBUTING.md#setting-up-your-eclipse-and-github-account). + +For every patch we require a [corresponding GitHub issue](https://github.com/eclipse/nebula/issues). +See the [recommended workflow](https://github.com/eclipse-platform/.github/blob/main/CONTRIBUTING.md#setting-up-your-eclipse-and-github-account) for guidelines. ## Setup a Development enviroment +Please use the following automated setup to configure a development environment pull requests: + [![Create Eclipse Development Environment for Eclipse Nebula](https://download.eclipse.org/oomph/www/setups/svg/Nebula.svg)](https://www.eclipse.org/setups/installer/?url=https://raw.githubusercontent.com/eclipse/nebula/master/configuration.setup&show=true "Click to open Eclipse-Installer Auto Launch or drag into your running installer") ## Building on our build server -After admin approval, pull requests gets build by these two jobs: - * [Stable Widgets](https://ci.eclipse.org/nebula/job/nebula.stable.github/) - * [Incubation Widgets](https://ci.eclipse.org/nebula/job/nebula.incubation.github/) +After admin approval, pull requests get built by this job: + * [Pull Request Builds](https://ci.eclipse.org/nebula/job/nebula-build/view/change-requests/) ## Building locally git clone https://github.com/eclipse/nebula.git - cd releng/org.eclipse.nebula.nebula-release mvn verify - - cd releng/org.eclipse.nebula.nebula-incubation - mvn verify (or install to install in the local maven repo) -More info can be found on the [the builds page](https://wiki.eclipse.org/Nebula/Builds) +More info can be found on Nebula's [Build Server](https://ci.eclipse.org/nebula/). ## New Committers Before you decide to contribute your code to Eclipse, keep in mind that your code must follow the EPL, Eclipse's Public License. @@ -45,14 +47,13 @@ A good overview of what this entails and how this affects you [can be read here] There are a number of ways you can contribute. -* A new project inside Nebula -* New widgets in the Nebula Release project (production ready). -* New widgets in the Nebula Incubation project. -* Maintain existing widgets +* A new project inside Nebula. +* New widgets in the Nebula project. +* Maintain existing widgets. -If you choose any of these option contact the Nebula devs through the +If you choose any of these option contact the Nebula developers through the [mailing list](https://dev.eclipse.org/mailman/listinfo/nebula-dev) -and state your intentions. +and state your intentions, or open an issue. ## New Widgets The 'New Widget' process is described here: