summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 33d89786..f6e36e74 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
1<!--
2 SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
3
4 SPDX-License-Identifier: EPL-2.0
5-->
6
1# Refinery 7# Refinery
2 8
3[![Build](https://github.com/graphs4value/refinery/actions/workflows/build.yml/badge.svg)](https://github.com/graphs4value/refinery/actions/workflows/build.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=graphs4value_refinery&metric=alert_status)](https://sonarcloud.io/dashboard?id=graphs4value_refinery) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=graphs4value_refinery&metric=coverage)](https://sonarcloud.io/dashboard?id=graphs4value_refinery) 9[![Build](https://github.com/graphs4value/refinery/actions/workflows/build.yml/badge.svg)](https://github.com/graphs4value/refinery/actions/workflows/build.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=graphs4value_refinery&metric=alert_status)](https://sonarcloud.io/dashboard?id=graphs4value_refinery) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=graphs4value_refinery&metric=coverage)](https://sonarcloud.io/dashboard?id=graphs4value_refinery)
@@ -6,7 +12,7 @@
6 12
7### With Eclipse IDE 13### With Eclipse IDE
8 14
91. Download and install a _Java 19_ compatible JDK. For Windows, prefer OpenJDK builds from [Adoptium](https://adoptium.net/). 151. Download and install a _Java 17_ compatible JDK. For Windows, prefer OpenJDK builds from [Adoptium](https://adoptium.net/).
10 16
112. Download and extract the [Eclipse IDE for Java and DSL Developers 2022-09](https://www.eclipse.org/downloads/packages/release/2022-09/r/eclipse-ide-java-and-dsl-developers) package. 172. Download and extract the [Eclipse IDE for Java and DSL Developers 2022-09](https://www.eclipse.org/downloads/packages/release/2022-09/r/eclipse-ide-java-and-dsl-developers) package.
12 18
@@ -17,16 +23,15 @@
17 23
185. Open _Help > Eclipse Marketplace_ and install the following software: 245. Open _Help > Eclipse Marketplace_ and install the following software:
19 * _EclEmma Java Code Coverage_ 25 * _EclEmma Java Code Coverage_
20 * _Java 19 Support for Eclipse 2022-09 (4.25)_
21 * _SonarLint_ 26 * _SonarLint_
22 27
236. Open _Window > Preferences_ and set the following preferences: 286. Open _Window > Preferences_ and set the following preferences:
24 * _General > Workspace > Text file encoding_ should be _UTF-8_. 29 * _General > Workspace > Text file encoding_ should be _UTF-8_.
25 * _General > Workspace > New text file line delimiter_ should be _Unix_. 30 * _General > Workspace > New text file line delimiter_ should be _Unix_.
26 * Add the JDK 19 to _Java > Installed JREs_. 31 * Add the JDK 17 to _Java > Installed JREs_.
27 * Make sure JDK 19 is selected for _JavaSE-19_ at _Java > Installed JREs > Execution Environments_. 32 * Make sure JDK 17 is selected for _JavaSE-17_ at _Java > Installed JREs > Execution Environments_.
28 * Set _Gradle > Java home_ to the `JAVA_HOME` directory (the directory which contains the `bin` directory) of JDK 17. Here, Buildship will show a yellow warning sign, which can be safely ignored. 33 * Set _Gradle > Java home_ to the `JAVA_HOME` directory (the directory which contains the `bin` directory) of JDK 17. Here, Buildship will show a yellow warning sign, which can be safely ignored.
29 * Set _Java > Compiler > JDK Compliance > Compiler compliance level_ to _19_. The warning about using Java 16 system libraries during compilation should disappear. 34 * Set _Java > Compiler > JDK Compliance > Compiler compliance level_ to _17_.
30 35
317. Clone the project Git repository but do not import it into Eclipse yet. 367. Clone the project Git repository but do not import it into Eclipse yet.
32 37
@@ -45,4 +50,9 @@ It is possible to import the project into IntelliJ IDEA, but it gives no editing
45 50
46## License 51## License
47 52
48All code in this repository is available under the [Eclipse Public License - v 2.0](https://www.eclipse.org/legal/epl-2.0/). 53Copyright (c) 2021-2023 [The Refinery Authors](CONTRIBUTORS.md)
54
55Refinery is available under the [Eclipse Public License - v 2.0](https://www.eclipse.org/legal/epl-2.0/).
56
57Refinery complies with the [REUSE Specification – Version 3.0](https://reuse.software/) to provide copyright and licensing information to each file, including files available under other licenses.
58For more information, see the comments headers in each file and the license texts in the [LICENSES](LICENSES/) directory.