You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by cd...@apache.org on 2023/10/02 12:40:01 UTC
[plc4x] 01/02: docs: Added some more profiles to the documentation to really build everything.
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
commit e4dec500c1ca4d46b95b1f9294f0836142e37729
Author: Christofer Dutz <cd...@apache.org>
AuthorDate: Mon Oct 2 14:39:21 2023 +0200
docs: Added some more profiles to the documentation to really build everything.
---
README.md | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index da9781e03c..2e4b6f2c1c 100644
--- a/README.md
+++ b/README.md
@@ -40,12 +40,12 @@
# Table of contents
- * [About PLC4X](#about-apache-plc4x)
- * [Getting Started](#getting-started)
- * [Developers](#developers)
- * [Community](#community)
- * [Contributing](#contributing)
- * [Licensing](#licensing)
+* [About PLC4X](#about-apache-plc4x)
+* [Getting Started](#getting-started)
+* [Developers](#developers)
+* [Community](#community)
+* [Contributing](#contributing)
+* [Licensing](#licensing)
***
@@ -75,15 +75,15 @@ And brings stand-alone (Java) utils like:
It also provides (Java) tools for usage inside an application:
-* Connection Cache: New implementation of our framework for re-using and sharing PLC-connections
+* Connection Cache: New implementation of our framework for re-using and sharing PLC-connections
* Connection Pool: Old implementation of our framework for re-using and sharing PLC-connections
* OPM: Object-Plc-Mapping: Allows binding PLC fields to properties in java POJOs similar to JPA
* Scraper: Utility to do scheduled and repeated data collection.
## Getting started
-Depending on the programming language, the usage will differ, therefore please go to the
-[Getting Started](https://plc4x.apache.org/users/gettingstarted.html) on the PLC4X website to look up
+Depending on the programming language, the usage will differ, therefore please go to the
+[Getting Started](https://plc4x.apache.org/users/gettingstarted.html) on the PLC4X website to look up
the language of choice.
### Java
@@ -148,7 +148,7 @@ Per default will it store files locally:
- Deployed artifacts will go to `out/.local-snapshots-dir`
The reason for this is, that otherwise the artifacts would be packaged in with the source-release artifact, resulting in a 12GB or more zip archive.
-However, saving it in the main `target` directory would make the build delete the local repo every time a `mvn clean` is run.
+However, saving it in the main `target` directory would make the build delete the local repo every time a `mvn clean` is run.
The `out` directory however is excluded per default from the assembly descriptor, and therefore it is not included in the source zim.
### Getting Started
@@ -156,7 +156,7 @@ The `out` directory however is excluded per default from the assembly descriptor
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: When using Java 19 currently the Apache Kafka integration module is excluded from the build as one of the plugins it requires has proven to be incompatible with this version.
+NOTE: When using Java 19 currently the Apache Kafka integration module is excluded from the build as one of the plugins it requires has proven to be incompatible with this version.
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.
@@ -203,7 +203,7 @@ In order to be able to build the Python module, you currently need to activate t
In order to build everything the following command should work:
```
-./mvnw -P with-c,with-go,with-python,with-sandbox install
+./mvnw -P with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks install
```
## Community
@@ -212,7 +212,7 @@ Join the PLC4X community by using one of the following channels. We'll be glad t
### Mailing Lists
-Subscribe to the following mailing lists:
+Subscribe to the following mailing lists:
* Apache PLC4X Developer List: [dev-subscribe@plc4x.apache.org](mailto:dev-subscribe@plc4x.apache.org)
* Apache PLC4X Commits List: [commits-subscribe@plc4x.apache.org](mailto:commits-subscribe@plc4x.apache.org)
* Apache PLC4X Jira Notification List: [issues-subscribe@plc4x.apache.org](mailto:issues-subscribe@plc4x.apache.org)
@@ -238,7 +238,7 @@ These are, but are not limited to:
* Documentation
We are a very friendly bunch so don’t be afraid to step forward.
-If you'd like to contribute to PLC4X, have a look at our
+If you'd like to contribute to PLC4X, have a look at our
[contribution guide](https://plc4x.apache.org/developers/contributing.html)!
## Licensing