Skip to content

Commit

Permalink
documentation: Updated the README to name Java 11 as minimum version
Browse files Browse the repository at this point in the history
fix: bumped log4j to 2.16.0
  • Loading branch information
chrisdutz committed Dec 14, 2021
1 parent 6986739 commit 101287a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ We are planning on shipping libraries for usage in:

1. Java
2. Go
3. C/C++ (not ready for usage)
3. C (not ready for usage)
4. Python (not ready for usage)
5. C# (.Net) (not ready for usage)

Expand All @@ -73,8 +73,7 @@ the language of choice.

### Java

NOTE: Currently the Java version which supports building of all parts of Apache PLC4X is exactly Java 11
(Higher versions can't build the Logstash integration and lower versions can't build the CMake dependent parts).
NOTE: Currently the Java version which supports building of all parts of Apache PLC4X is at least Java 11

See the PLC4J user guide on the website to start using PLC4X in your Java application:
[https://plc4x.apache.org/users/getting-started/plc4j.html](https://plc4x.apache.org/users/getting-started/plc4j.html)
Expand All @@ -85,7 +84,7 @@ See the PLC4J user guide on the website to start using PLC4X in your Java applic

Currently, the project is configured to require the following software:

1. Java 8 JDK: For running Maven in general as well as compiling the Java and Scala modules `JAVA_HOME` configured to
1. Java 11 JDK: For running Maven in general as well as compiling the Java and Scala modules `JAVA_HOME` configured to
point to that.
2. libpcap/WinPcap for raw socket tests in Java or use of `passive-mode` drivers
3. (Optional) [Graphviz](https://www.graphviz.org/) : For generating the graphs in the documentation
Expand Down Expand Up @@ -202,9 +201,8 @@ If you don't want to bother setting up the environment on your normal system and

### Getting Started

You must have at least Java 8 installed on your system and connectivity to Maven Central
(for downloading external third party dependencies). However in order to build all parts
of PLC4X exactly Java 11 is required. Maven 3.6 is required to build, so be sure it's installed and available on your system.
You must have at least Java 11 installed on your system and connectivity to Maven Central
(for downloading external third party dependencies). Maven 3.6 is required to build, so be sure it's installed and available on your system.

NOTE: There is a convenience Maven-Wrapper installed in the repo, when used, this automatically downloads and installs Maven. If you want to use this, please use `./mvnw` or `mvnw` instead of the normal `mvn` command.

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@
<jserialcom.version>2.7.0</jserialcom.version>
<junit.jupiter.version>5.7.2</junit.jupiter.version>
<junit.platform.version>1.7.2</junit.platform.version>
<log4j.version>2.15.0</log4j.version>
<log4j.version>2.16.0</log4j.version>
<logback.version>1.2.5</logback.version>
<milo.version>0.6.3</milo.version>
<mockito.version>3.12.4</mockito.version>
Expand Down

0 comments on commit 101287a

Please sign in to comment.