[incubator-plc4x] 02/02: - Added missing README and RELEASE_NOTES files.

[cd...@apache.org]

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

commit 87a23684ae637317fd81a59d80353c6d21edf6eb
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Thu Sep 20 08:31:17 2018 +0200

    - Added missing README and RELEASE_NOTES files.
---
 README        | 38 ++++++++++++++++++++++++++++++++++++++
 RELEASE_NOTES | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+)

diff --git a/README b/README
new file mode 100644
index 0000000..f8ba9b5
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+Building the Apache PLC4X from a Source Distribution
+
+Quickstart
+----------
+
+You must have Java 8 installed on your system and connectivity to Maven Central
+(for downloading external third party dependencies). Maven will be automatically
+downloaded and installed by the maven wrapper `mvnw`.
+
+Build PLC4X jars and install them in your local maven repository
+
+$ ./mvnw install  # add -DskipTests to omit running the tests
+
+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
+----------------------
+
+Some parts of PLC4X, especially the raw socket support, require installed versions
+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
+---------
+
+Apache PLC4X is released under the Apache License Version 2.0.
+
+Apache PLC4X is an effort undergoing incubation at The Apache Software Foundation (ASF),
+sponsored by the Incubator PMC. Incubation is required of all newly accepted
+projects until a further review indicates that the infrastructure, communications,
+and decision making process have stabilized in a manner consistent with other
+successful ASF projects. While incubation status is not necessarily a reflection
+of the completeness or stability of the code, it does indicate that the project
+has yet to be fully endorsed by the ASF.
diff --git a/RELEASE_NOTES b/RELEASE_NOTES
new file mode 100644
index 0000000..7083a57
--- /dev/null
+++ b/RELEASE_NOTES
@@ -0,0 +1,45 @@
+Apache PLC4X (incubating) 0.1.0
+===============================
+
+This is the first official release of Apache PLC4X.
+It contains drivers for the following protocols:
+- Siemens S7comm (0x32)
+- Beckhoff ADS
+- Modbus
+- EtherNet/IP
+
+However the Siemens driver definitely is the most
+mature driver, the rest should be treated experimental.
+
+New Features
+------------
+
+PLC4X-29	[S7] Implement PDU Fragmentation
+PLC4X-39	Extend the Edgent integration with the new Subscription features of PLC4X
+
+Incompatible changes
+--------------------
+
+- NONE -
+
+Miscellaneous changes
+---------------------  
+
+- NONE -
+
+Known Issues
+------------
+
+- NONE -
+
+Most drivers should be treated experimental and are not near production ready.
+The S7 driver is probably the furthest implemented and tested driver and hereby can be 
+considered to be the most mature.
+
+Bug Fixes
+---------
+
+PLC4X-20	Jacoco doesn't seem to be working at all
+PLC4X-21	Code coverage doesn't seem to work
+PLC4X-47	S7 driver silently ignores surplus ReadRequestItems
+PLC4X-48	S7 driver failes to parse response with multiple items