You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2018/02/13 22:27:08 UTC
[11/14] commons-rng git commit: Re-generated "README.md" files.
Re-generated "README.md" files.
Project: http://git-wip-us.apache.org/repos/asf/commons-rng/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-rng/commit/e8537efb
Tree: http://git-wip-us.apache.org/repos/asf/commons-rng/tree/e8537efb
Diff: http://git-wip-us.apache.org/repos/asf/commons-rng/diff/e8537efb
Branch: refs/heads/master
Commit: e8537efb9ebc9f70fc33e09904e0f43c35e167d4
Parents: a960ee1
Author: Gilles <er...@apache.org>
Authored: Tue Feb 13 21:01:39 2018 +0100
Committer: Gilles <er...@apache.org>
Committed: Tue Feb 13 21:01:39 2018 +0100
----------------------------------------------------------------------
commons-rng-examples/README.md | 106 +++++++++++++++++++
commons-rng-examples/examples-jmh/README.md | 17 +--
commons-rng-examples/examples-jpms/README.md | 8 +-
.../examples-jpms/jpms-app/README.md | 16 +--
.../examples-jpms/jpms-lib/README.md | 16 +--
.../examples-quadrature/README.md | 106 +++++++++++++++++++
.../examples-sampling/README.md | 106 +++++++++++++++++++
commons-rng-examples/examples-stress/README.md | 106 +++++++++++++++++++
8 files changed, 453 insertions(+), 28 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/README.md b/commons-rng-examples/README.md
new file mode 100644
index 0000000..f01dc3e
--- /dev/null
+++ b/commons-rng-examples/README.md
@@ -0,0 +1,106 @@
+<!---
+ 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.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons RNG Examples
+===================
+
+[](https://travis-ci.org/apache/commons-rng-examples)
+[](https://coveralls.io/r/apache/commons-rng-examples)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Examples of use of the random numbers generator implemented in the "commons-rng-simple" module.
+ Code in this module is not part of the public API.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons RNG Examples homepage](https://commons.apache.org/proper/commons-rng).
+The [JavaDoc](https://commons.apache.org/proper/commons-rng/javadocs/api-release) can be browsed.
+Questions related to the usage of Apache Commons RNG Examples should be posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-rng-examples</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons RNG Examples? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/examples-jmh/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/examples-jmh/README.md b/commons-rng-examples/examples-jmh/README.md
index f993421..562d1fb 100644
--- a/commons-rng-examples/examples-jmh/README.md
+++ b/commons-rng-examples/examples-jmh/README.md
@@ -40,22 +40,23 @@
| |
+======================================================================+
--->
-Apache Commons RNG JMH
+Apache Commons RNG JMH Benchmark
===================
-[](https://travis-ci.org/apache/commons-rng-jmh)
-[](https://coveralls.io/r/apache/commons-rng-jmh)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-jmh/)
+[](https://travis-ci.org/apache/commons-rng-examples-jmh)
+[](https://coveralls.io/r/apache/commons-rng-examples-jmh)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jmh/)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
Code for running JMH benchmarks that assess the performance of the generators.
+ Code in this module is not part of the public API.
Documentation
-------------
-More information can be found on the [Apache Commons RNG JMH homepage](https://commons.apache.org/proper/commons-rng).
+More information can be found on the [Apache Commons RNG JMH Benchmark homepage](https://commons.apache.org/proper/commons-rng).
The [JavaDoc](https://commons.apache.org/proper/commons-rng/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons RNG JMH should be posted to the [user mailing list][ml].
+Questions related to the usage of Apache Commons RNG JMH Benchmark should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -66,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
- <artifactId>commons-rng-jmh</artifactId>
+ <artifactId>commons-rng-examples-jmh</artifactId>
<version>1.0</version>
</dependency>
```
@@ -92,7 +93,7 @@ See the `NOTICE.txt` file for required notices and attributions.
Donations
---------
-You like Apache Commons RNG JMH? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons RNG JMH Benchmark? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/examples-jpms/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/examples-jpms/README.md b/commons-rng-examples/examples-jpms/README.md
index 690eb48..0d3d0f8 100644
--- a/commons-rng-examples/examples-jpms/README.md
+++ b/commons-rng-examples/examples-jpms/README.md
@@ -43,9 +43,9 @@
Apache Commons RNG Integration
===================
-[](https://travis-ci.org/apache/commons-rng-jpms)
-[](https://coveralls.io/r/apache/commons-rng-jpms)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-jpms/)
+[](https://travis-ci.org/apache/commons-rng-examples-jpms)
+[](https://coveralls.io/r/apache/commons-rng-examples-jpms)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jpms/)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
Testing JPMS. Code in this module is not part of the public API.
@@ -66,7 +66,7 @@ Alternatively you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
- <artifactId>commons-rng-jpms</artifactId>
+ <artifactId>commons-rng-examples-jpms</artifactId>
<version>1.0</version>
</dependency>
```
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/examples-jpms/jpms-app/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/examples-jpms/jpms-app/README.md b/commons-rng-examples/examples-jpms/jpms-app/README.md
index 690eb48..aaa285f 100644
--- a/commons-rng-examples/examples-jpms/jpms-app/README.md
+++ b/commons-rng-examples/examples-jpms/jpms-app/README.md
@@ -40,12 +40,12 @@
| |
+======================================================================+
--->
-Apache Commons RNG Integration
+JPMS module example (application)
===================
-[](https://travis-ci.org/apache/commons-rng-jpms)
-[](https://coveralls.io/r/apache/commons-rng-jpms)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-jpms/)
+[](https://travis-ci.org/apache/commons-rng-examples-jpms-app)
+[](https://coveralls.io/r/apache/commons-rng-examples-jpms-app)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jpms-app/)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
Testing JPMS. Code in this module is not part of the public API.
@@ -53,9 +53,9 @@ Testing JPMS. Code in this module is not part of the public API.
Documentation
-------------
-More information can be found on the [Apache Commons RNG Integration homepage](https://commons.apache.org/proper/commons-rng).
+More information can be found on the [JPMS module example (application) homepage](https://commons.apache.org/proper/commons-rng).
The [JavaDoc](https://commons.apache.org/proper/commons-rng/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons RNG Integration should be posted to the [user mailing list][ml].
+Questions related to the usage of JPMS module example (application) should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -66,7 +66,7 @@ Alternatively you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
- <artifactId>commons-rng-jpms</artifactId>
+ <artifactId>commons-rng-examples-jpms-app</artifactId>
<version>1.0</version>
</dependency>
```
@@ -92,7 +92,7 @@ See the `NOTICE.txt` file for required notices and attributions.
Donations
---------
-You like Apache Commons RNG Integration? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like JPMS module example (application)? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/examples-jpms/jpms-lib/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/examples-jpms/jpms-lib/README.md b/commons-rng-examples/examples-jpms/jpms-lib/README.md
index 690eb48..8d6ceb0 100644
--- a/commons-rng-examples/examples-jpms/jpms-lib/README.md
+++ b/commons-rng-examples/examples-jpms/jpms-lib/README.md
@@ -40,12 +40,12 @@
| |
+======================================================================+
--->
-Apache Commons RNG Integration
+JPMS module example (library)
===================
-[](https://travis-ci.org/apache/commons-rng-jpms)
-[](https://coveralls.io/r/apache/commons-rng-jpms)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-jpms/)
+[](https://travis-ci.org/apache/commons-rng-examples-jpms-lib)
+[](https://coveralls.io/r/apache/commons-rng-examples-jpms-lib)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jpms-lib/)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
Testing JPMS. Code in this module is not part of the public API.
@@ -53,9 +53,9 @@ Testing JPMS. Code in this module is not part of the public API.
Documentation
-------------
-More information can be found on the [Apache Commons RNG Integration homepage](https://commons.apache.org/proper/commons-rng).
+More information can be found on the [JPMS module example (library) homepage](https://commons.apache.org/proper/commons-rng).
The [JavaDoc](https://commons.apache.org/proper/commons-rng/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons RNG Integration should be posted to the [user mailing list][ml].
+Questions related to the usage of JPMS module example (library) should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -66,7 +66,7 @@ Alternatively you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
- <artifactId>commons-rng-jpms</artifactId>
+ <artifactId>commons-rng-examples-jpms-lib</artifactId>
<version>1.0</version>
</dependency>
```
@@ -92,7 +92,7 @@ See the `NOTICE.txt` file for required notices and attributions.
Donations
---------
-You like Apache Commons RNG Integration? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like JPMS module example (library)? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/examples-quadrature/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/examples-quadrature/README.md b/commons-rng-examples/examples-quadrature/README.md
new file mode 100644
index 0000000..0123f39
--- /dev/null
+++ b/commons-rng-examples/examples-quadrature/README.md
@@ -0,0 +1,106 @@
+<!---
+ 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.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons RNG Quadrature Test Example
+===================
+
+[](https://travis-ci.org/apache/commons-rng-examples-quadrature)
+[](https://coveralls.io/r/apache/commons-rng-examples-quadrature)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-quadrature/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Application for calling external tools that perform stringent uniformity tests.
+ Code in this module is not part of the public API.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons RNG Quadrature Test Example homepage](https://commons.apache.org/proper/commons-rng).
+The [JavaDoc](https://commons.apache.org/proper/commons-rng/javadocs/api-release) can be browsed.
+Questions related to the usage of Apache Commons RNG Quadrature Test Example should be posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-rng-examples-quadrature</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons RNG Quadrature Test Example? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/examples-sampling/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/examples-sampling/README.md b/commons-rng-examples/examples-sampling/README.md
new file mode 100644
index 0000000..16e71a9
--- /dev/null
+++ b/commons-rng-examples/examples-sampling/README.md
@@ -0,0 +1,106 @@
+<!---
+ 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.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons RNG Sampling Test Example
+===================
+
+[](https://travis-ci.org/apache/commons-rng-examples-sampling)
+[](https://coveralls.io/r/apache/commons-rng-examples-sampling)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-sampling/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Application for calling external tools that perform stringent uniformity tests.
+ Code in this module is not part of the public API.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons RNG Sampling Test Example homepage](https://commons.apache.org/proper/commons-rng).
+The [JavaDoc](https://commons.apache.org/proper/commons-rng/javadocs/api-release) can be browsed.
+Questions related to the usage of Apache Commons RNG Sampling Test Example should be posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-rng-examples-sampling</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons RNG Sampling Test Example? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/e8537efb/commons-rng-examples/examples-stress/README.md
----------------------------------------------------------------------
diff --git a/commons-rng-examples/examples-stress/README.md b/commons-rng-examples/examples-stress/README.md
new file mode 100644
index 0000000..eabba37
--- /dev/null
+++ b/commons-rng-examples/examples-stress/README.md
@@ -0,0 +1,106 @@
+<!---
+ 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.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons RNG Stress Test Example
+===================
+
+[](https://travis-ci.org/apache/commons-rng-examples-stress)
+[](https://coveralls.io/r/apache/commons-rng-examples-stress)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-stress/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Application for calling external tools that perform stringent uniformity tests.
+ Code in this module is not part of the public API.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons RNG Stress Test Example homepage](https://commons.apache.org/proper/commons-rng).
+The [JavaDoc](https://commons.apache.org/proper/commons-rng/javadocs/api-release) can be browsed.
+Questions related to the usage of Apache Commons RNG Stress Test Example should be posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-rng-examples-stress</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons RNG Stress Test Example? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html