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 2018/09/20 07:22:17 UTC
[incubator-plc4x] branch master updated: - Merged the new and the
old README.md and removed the Markdown version after that.
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
The following commit(s) were added to refs/heads/master by this push:
new 11ce613 - Merged the new and the old README.md and removed the Markdown version after that.
11ce613 is described below
commit 11ce613894d816f2d35386a62cdd8d9a958a0a0d
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Thu Sep 20 09:22:13 2018 +0200
- Merged the new and the old README.md and removed the Markdown version after that.
---
README | 32 +++++++++++++++++++++++++++++---
README.md | 64 ---------------------------------------------------------------
2 files changed, 29 insertions(+), 67 deletions(-)
diff --git a/README b/README
index f8ba9b5..25997fa 100644
--- a/README
+++ b/README
@@ -1,7 +1,31 @@
-Building the Apache PLC4X from a Source Distribution
+Apache PLC4X
+============
-Quickstart
-----------
+Apache PLC4X is an effort to create a set of libraries for communicating with industrial grade programmable logic controllers (PLCs) in a uniform way.
+We are planning on shipping libraries for usage in:
+
+1) Java
+2) Scala
+3) C/C++
+
+As well as provide direct integration into other Apache projects, such as:
+
+1) Apache Camel
+2) Apache Edgent
+3) Apache Kafka-Connect
+
+
+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/)
+
+
+Getting Started
+---------------
You must have Java 8 installed on your system and connectivity to Maven Central
(for downloading external third party dependencies). Maven will be automatically
@@ -15,6 +39,7 @@ You can now construct applications that use PLC4X. The PLC4X samples
are a good place to start and are available inside the `examples`
directory.
+
Additional Information
----------------------
@@ -24,6 +49,7 @@ 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/
+
Licensing
---------
diff --git a/README.md b/README.md
deleted file mode 100644
index ea81b7b..0000000
--- a/README.md
+++ /dev/null
@@ -1,64 +0,0 @@
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
--->
-# Welcome to Apache PLC4X!
-
-Apache PLC4X is an effort to create a set of libraries for communicating with industrial grade programmable logic controllers (PLCs) in a uniform way.
-We are planning on shipping libraries for usage in:
-
-1) Java
-2) Scala
-3) C/C++
-
-As well as provide direct integration into other Apache projects, such as:
-
-1) Apache Edgent
-2) Apache Mynewt
-
-## 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/)
-
-## Getting Started
-
-As currently a lot of the work is being done in the documentation and this is handled by mavens site plugin, in order to get all parts built, it is important to also trigger Mavens site generation.
-This is done by adding the `site:site` goal to the execution.
-
-Unix/Linux/Mac:
-
- ./mvnw clean install site:site
-
-Windows:
-
- mvnw.cmd clean install site:site
-
-This will generate all artifacts as well as their documentation.
-In order to locally fully test the generated documentation site, it is advisable to add another goal `site:stage` to the build, which will copy the sub-sites of all modules into one directory `target/staging`.
-Without this the links between modules will not work correctly.
-
-Unix/Linux/Mac:
-
- ./mvnw clean install site:site site:stage
-
-Windows:
-
- mvnw.cmd clean install site:site site:stage
-