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 2019/01/17 14:11:29 UTC
[incubator-plc4x] 02/02: README - Updated the integration module
list - Updated the requirements - Added information on installing
libpcap/WinPcap - Added a section on building with C++
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/incubator-plc4x.git
commit d8588bfc481b22b18090ee0c510d35c656c9368d
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Thu Jan 17 15:11:24 2019 +0100
README
- Updated the integration module list
- Updated the requirements
- Added information on installing libpcap/WinPcap
- Added a section on building with C++
---
DEVELOPMENT.md | 2 +-
README | 35 +++++++++++++++++++++++++++--------
plc4cpp/README.md | 3 ++-
3 files changed, 30 insertions(+), 10 deletions(-)
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 1a8a0aa..2c53169 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -36,7 +36,7 @@
- Usage of default implementations does cause more problems than it solves in this case.
## IDE specific
-- For formatting there is a .editorconfig defined. Intellij Idea come with a plugin for this preinstalled, for eclipse an installation is required (http://editorconfig.org/).
+- For formatting there is a .editorconfig defined. Intellij Idea come with a plugin for this pre-installed, for eclipse an installation is required (http://editorconfig.org/).
- Import organizing uses the Intellij Idea default:
- Import order
- all other imports
diff --git a/README b/README
index 25997fa..bcce994 100644
--- a/README
+++ b/README
@@ -10,9 +10,12 @@ We are planning on shipping libraries for usage in:
As well as provide direct integration into other Apache projects, such as:
-1) Apache Camel
-2) Apache Edgent
-3) Apache Kafka-Connect
+1) Apache Calcite
+2) Apache Camel
+3) Apache Edgent
+4) Apache Kafka-Connect
+5) Apache Karaf
+6) Apache NiFi
Environment
@@ -21,7 +24,8 @@ Environment
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 point to that.
-2) (Optional) Graphwiz: For generating the graphs in the documentation (http://www.graphviz.org/)
+2) libpcap/WinPcap for raw socket tests
+3) (Optional) Graphwiz: For generating the graphs in the documentation (http://www.graphviz.org/)
Getting Started
@@ -40,14 +44,29 @@ are a good place to start and are available inside the `examples`
directory.
-Additional Information
-----------------------
+Installing libpcap/WinPcap
+--------------------------
Some parts of PLC4X, especially the raw socket support, require installed versions
-of libpcap/WinPcap.
+of libpcap/WinPcap.
You can download the Mac/Linux version from: http://www.tcpdump.org/
-The windows version can be found here: https://www.winpcap.org/install/
+The windows version can be found here: https://sourceforge.net/projects/winpcap413-176/
+(In order to read PCAPNG files we require a libpcap version 1.1.0 or greater. The default
+Windows version is 1.0. At this location is a patched version based on libpcap 1.7.4)
+
+
+Building the C++ libraries
+--------------------------
+
+When building the C++ libraries we require an installed `gcc` compiler.
+On Mac and Linux this is usually the case.
+
+On Windows this usually is not.
+The build is optimized for using a gcc-port called MinGW, available from
+http://win-builds.org/doku.php/download_and_installation_from_windows
+Make sure the `bin` directory containing the executable `mingw32-make.exe`
+is on your systems `PATH`.
Licensing
diff --git a/plc4cpp/README.md b/plc4cpp/README.md
index f720020..653c771 100644
--- a/plc4cpp/README.md
+++ b/plc4cpp/README.md
@@ -22,7 +22,8 @@ On mac and linux machines there should not be a requirement to install any prere
In general the build requires `gcc` being installed.
On Windows machines, you might need to install it manually.
-He have tested everything with the bundle of http://win-builds.org/doku.php
+He have tested everything with the bundle of
+http://win-builds.org/doku.php/download_and_installation_from_windows
Make sure the `bin` directory containing the executable `mingw32-make.exe` is on your systems `PATH`.
In the `plc4cpp-libs` module all third party dependencies will be built that are needed by any of the other plc4cpp modules.