OpenSourceArk
/
quarkus
mirror of https://github.com/quarkusio/quarkus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md and CONTRIBUTING.md for Java 17+

This commit is contained in:
Guillaume Smet 2023-11-30 14:50:43 +01:00
parent b98564751c
commit 53e0584433
No known key found for this signature in database
GPG Key ID: C2AD9C8A7D4E988A
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -227,7 +227,7 @@ If you have not done so on this machine, you need to:
* macOS: Use the `Disk Utility.app` to check. It also allows you to create a case-sensitive volume to store your code projects. See this [blog entry](https://karnsonline.com/case-sensitive-apfs/) for more.
* Windows: [Enable case sensitive file names per directory](https://learn.microsoft.com/en-us/windows/wsl/case-sensitivity)
* Install Git and configure your GitHub access
* Install Java SDK 11+ (OpenJDK recommended)
* Install Java SDK 17+ (OpenJDK recommended)
* Install [GraalVM](https://quarkus.io/guides/building-native-image)
* Install platform C developer tools:
* Linux
@ -357,7 +357,7 @@ in `quarkus-parent` (root `pom.xml`).
When contributing to Quarkus, it is recommended to respect the following rules.
> **Note:** The `impsort-maven-plugin` uses the `.cache` directory on each module to speed up the build.
> Because we have configured the plugin to store in a versioned directory, you may notice over time that the `.cache` directory grows in size. You can safely delete the `.cache` directory in each module to reclaim the space.
> Because we have configured the plugin to store in a versioned directory, you may notice over time that the `.cache` directory grows in size. You can safely delete the `.cache` directory in each module to reclaim the space.
> Running `./mvnw clean -Dclean-cache` automatically deletes that directory for you.
**Contributing to an extension**
@ -748,7 +748,7 @@ This project is an open source project, please act responsibly, be nice, polite
See section `IDEA Setup` as there are different possible solutions described.
* IntelliJ does not recognize the project as a Java 11 project
* IntelliJ does not recognize the project as a Java 17 project
In the Maven pane, uncheck the `include-jdk-misc` and `compile-java8-release-flag` profiles
@ -787,5 +787,5 @@ This project is an open source project, please act responsibly, be nice, polite
...
```
* Tests fail with `Caused by: io.quarkus.runtime.QuarkusBindException: Port(s) already bound: 8080: Address already in use`
Check that you do not have other Quarkus dev environments, apps or other web servers running on this default 8080 port.

4
README.md
View File

@ -7,7 +7,7 @@
[![License](https://img.shields.io/github/license/quarkusio/quarkus?style=for-the-badge&logo=apache)](https://www.apache.org/licenses/LICENSE-2.0)
[![Project Chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg?style=for-the-badge&logo=zulip)](https://quarkusio.zulipchat.com/)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?style=for-the-badge&logo=gitpod&logoColor=white)](https://gitpod.io/#https://github.com/quarkusio/quarkus/-/tree/main/)
[![Supported JVM Versions](https://img.shields.io/badge/JVM-11--17--21-brightgreen.svg?style=for-the-badge&logo=openjdk)](https://github.com/quarkusio/quarkus/actions/runs/113853915/)
[![Supported JVM Versions](https://img.shields.io/badge/JVM-17--21-brightgreen.svg?style=for-the-badge&logo=openjdk)](https://github.com/quarkusio/quarkus/actions/runs/113853915/)
[![Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?style=for-the-badge&logo=gradle)](https://ge.quarkus.io/scans)
[![GitHub Repo stars](https://img.shields.io/github/stars/quarkusio/quarkus?style=for-the-badge)](https://github.com/quarkusio/quarkus/stargazers)
@ -15,7 +15,7 @@
Quarkus is a Cloud Native, (Linux) Container First framework for writing Java applications.
* **Container First**:
* **Container First**:
Minimal footprint Java applications optimal for running in containers.
* **Cloud Native**:
Embraces [12 factor architecture](https://12factor.net) in environments like Kubernetes.