This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 9ed328b57e4c309559d52a6c4aaa8069db7de87a
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Mon Jul 15 12:35:56 2024 +0100
Update README pages following 1.6 release
---
README.md | 43 +++++++++++-------
commons-rng-bom/README.md | 28 ++++++------
commons-rng-client-api/README.md | 43 +++++++++++-------
commons-rng-core/README.md | 43 +++++++++++-------
.../README.md | 48 +++++++-------------
commons-rng-examples/README.md | 47 +++++++-------------
commons-rng-examples/examples-jmh/README.md | 50 ++++++++-------------
commons-rng-examples/examples-jpms/README.md | 49 ++++++++-------------
.../examples-jpms/jpms-app/README.md | 50 ++++++++-------------
.../examples-jpms/jpms-lib/README.md | 51 ++++++++--------------
commons-rng-examples/examples-quadrature/README.md | 50 ++++++++-------------
commons-rng-examples/examples-sampling/README.md | 50 ++++++++-------------
commons-rng-examples/examples-stress/README.md | 50 ++++++++-------------
commons-rng-integration/README.md | 45 +++++++------------
commons-rng-sampling/README.md | 43 +++++++++++-------
commons-rng-simple/README.md | 43 +++++++++++-------
16 files changed, 317 insertions(+), 416 deletions(-)
diff --git a/README.md b/README.md
index 88ec7c32..00942fbb 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@
| 3) Example Properties |
| |
| <properties> |
- | <commons.componentid>rng</commons.componentid> |
+ | <commons.componentid>math</commons.componentid> |
| <commons.release.version>1.2</commons.release.version> |
| </properties> |
| |
@@ -43,11 +43,11 @@
Apache Commons RNG
===================
-[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-rng)
[](https://sonarcloud.io/dashboard?id=commons-rng)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-simple/)
-[](https://javadoc.io/doc/org.apache.commons/commons-rng-simple/1.5)
+[](https://javadoc.io/doc/org.apache.commons/commons-rng-simple/1.6)
The Apache Commons RNG project provides pure-Java implementation of
pseudo-random generators.
@@ -63,32 +63,40 @@ More information can be found on the [Apache Commons RNG
homepage](https://commo
Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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, e.g.:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-rng-simple</artifactId>
- <version>1.5</version>
+ <version>1.6</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-rng-sampling</artifactId>
- <version>1.5</version>
+ <version>1.6</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -97,20 +105,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-bom/README.md b/commons-rng-bom/README.md
index 6497a189..cb650bdd 100644
--- a/commons-rng-bom/README.md
+++ b/commons-rng-bom/README.md
@@ -31,10 +31,10 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-Questions related to the usage of Apache Commons RNG Sampling should be posted
to the [user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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 and use
@@ -46,7 +46,7 @@ the Bill of Materials (BOM) for dependency management:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-rng-bom</artifactId>
- <version>1.5</version>
+ <version>1.6</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -54,14 +54,13 @@ the Bill of Materials (BOM) for dependency management:
</dependencyManagement>
```
-
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -70,20 +69,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-client-api/README.md b/commons-rng-client-api/README.md
index 62dd46f4..e308f241 100644
--- a/commons-rng-client-api/README.md
+++ b/commons-rng-client-api/README.md
@@ -34,7 +34,7 @@
| 3) Example Properties |
| |
| <properties> |
- | <commons.componentid>rng</commons.componentid> |
+ | <commons.componentid>math</commons.componentid> |
| <commons.release.version>1.2</commons.release.version> |
| </properties> |
| |
@@ -43,10 +43,10 @@
Apache Commons RNG Client API
===================
-[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-rng)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-client-api/)
-[](https://javadoc.io/doc/org.apache.commons/commons-rng-client-api/1.5)
+[](https://javadoc.io/doc/org.apache.commons/commons-rng-client-api/1.6)
API for client code that uses random numbers generators.
@@ -54,11 +54,11 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-client-api/apidocs/)
can be browsed.
-Questions related to the usage of Apache Commons RNG Client API should be
posted to the [user mailing list][ml].
+The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-client-api/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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:
@@ -67,17 +67,25 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-rng-client-api</artifactId>
- <version>1.5</version>
+ <version>1.6</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-core/README.md b/commons-rng-core/README.md
index 28d6af44..704da4a0 100644
--- a/commons-rng-core/README.md
+++ b/commons-rng-core/README.md
@@ -34,7 +34,7 @@
| 3) Example Properties |
| |
| <properties> |
- | <commons.componentid>rng</commons.componentid> |
+ | <commons.componentid>math</commons.componentid> |
| <commons.release.version>1.2</commons.release.version> |
| </properties> |
| |
@@ -43,10 +43,10 @@
Apache Commons RNG Core
===================
-[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-rng)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-core/)
-[](https://javadoc.io/doc/org.apache.commons/commons-rng-core/1.5)
+[](https://javadoc.io/doc/org.apache.commons/commons-rng-core/1.6)
Pure Java implementations of random numbers generator algorithms.
Code in this module should not be used directly by applications; please use
@@ -58,11 +58,11 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs/)
can be browsed.
-Questions related to the usage of Apache Commons RNG Core should be posted to
the [user mailing list][ml].
+The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-core/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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:
@@ -71,17 +71,25 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-rng-core</artifactId>
- <version>1.5</version>
+ <version>1.6</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -90,20 +98,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-integration/README.md b/commons-rng-docs/README.md
similarity index 68%
copy from commons-rng-integration/README.md
copy to commons-rng-docs/README.md
index 5a04fb0b..f30362fe 100644
--- a/commons-rng-integration/README.md
+++ b/commons-rng-docs/README.md
@@ -20,48 +20,29 @@
|**** This file is ADAPTED from the README generated by the ****|
|**** commons build plugin and must be edited ****|
|**** ****|
- +======================================================================+
--->
-Apache Commons RNG Integration Tests
+Apache Commons RNG Documentation
===================
-Integration tests to validate an application referencing multiple Apache
Commons RNG artifacts
+Aggregator module to genenerate Apache Commons RNG documentation.
Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-Questions related to the usage of Apache Commons RNG Sampling should be posted
to the [user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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 and use
-the Bill of Materials (BOM) for dependency management:
-
-```xml
-<dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.apache.commons</groupId>
- <artifactId>commons-rng-bom</artifactId>
- <version>1.5</version>
- <type>pom</type>
- <scope>import</scope>
- </dependency>
- </dependencies>
-</dependencyManagement>
-```
-
-
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -70,20 +51,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/README.md b/commons-rng-examples/README.md
index 40635276..01e5d1cb 100644
--- a/commons-rng-examples/README.md
+++ b/commons-rng-examples/README.md
@@ -17,28 +17,10 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
Apache Commons RNG Examples
===================
@@ -52,19 +34,19 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-Questions related to the usage of Apache Commons RNG Examples should be posted
to the [user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -73,20 +55,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/examples-jmh/README.md
b/commons-rng-examples/examples-jmh/README.md
index 5b7677c5..69d70da4 100644
--- a/commons-rng-examples/examples-jmh/README.md
+++ b/commons-rng-examples/examples-jmh/README.md
@@ -17,30 +17,12 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
-JMH Benchmark
+Apache Commons RNG JMH Benchmark
===================
Code for running JMH benchmarks that assess the performance of the generators.
@@ -50,20 +32,19 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-examples/commons-rng-examples-jmh/apidocs/)
can be browsed.
-Questions related to the usage of JMH Benchmark should be posted to the [user
mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -72,20 +53,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/examples-jpms/README.md
b/commons-rng-examples/examples-jpms/README.md
index af9acff6..5c5e1f0b 100644
--- a/commons-rng-examples/examples-jpms/README.md
+++ b/commons-rng-examples/examples-jpms/README.md
@@ -17,30 +17,12 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
-JPMS Integration test
+Apache Commons RNG JPMS Integration Test
===================
Testing JPMS. Code in this module is not part of the public API.
@@ -49,19 +31,19 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-Questions related to the usage of JPMS Integration test should be posted to
the [user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -70,20 +52,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/examples-jpms/jpms-app/README.md
b/commons-rng-examples/examples-jpms/jpms-app/README.md
index 67e6f6b3..4507a107 100644
--- a/commons-rng-examples/examples-jpms/jpms-app/README.md
+++ b/commons-rng-examples/examples-jpms/jpms-app/README.md
@@ -17,30 +17,12 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
-JPMS module example (application)
+Apache Commons RNG JPMS Module Example (Application)
===================
Testing JPMS. Code in this module is not part of the public API.
@@ -49,20 +31,19 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-examples/commons-rng-examples-jpms/commons-rng-examples-jpms-app/apidocs/)
can be browsed.
-Questions related to the usage of JPMS module example (application) should be
posted to the [user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -71,20 +52,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/examples-jpms/jpms-lib/README.md
b/commons-rng-examples/examples-jpms/jpms-lib/README.md
index 5547a1bd..36fe2409 100644
--- a/commons-rng-examples/examples-jpms/jpms-lib/README.md
+++ b/commons-rng-examples/examples-jpms/jpms-lib/README.md
@@ -17,30 +17,12 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
-JPMS module example (library)
+Apache Commons RNG JPMS Module Example (Library)
===================
Testing JPMS. Code in this module is not part of the public API.
@@ -49,20 +31,20 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-examples/commons-rng-examples-jpms/commons-rng-examples-jpms-lib/apidocs/)
can be browsed.
-Questions related to the usage of JPMS module example (library) should be
posted to the [user mailing list][ml].
+The [Javadoc](https://commons.apache.org/proper/commons-rng/apidocs) can be
browsed.
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -71,20 +53,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/examples-quadrature/README.md
b/commons-rng-examples/examples-quadrature/README.md
index 90647f58..c8e21d77 100644
--- a/commons-rng-examples/examples-quadrature/README.md
+++ b/commons-rng-examples/examples-quadrature/README.md
@@ -17,30 +17,12 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
-Quadrature example
+Apache Commons RNG Quadrature Example
===================
Contains examples for computing numerical quadrature (integration).
@@ -50,20 +32,19 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-examples/commons-rng-examples-quadrature/apidocs/)
can be browsed.
-Questions related to the usage of Quadrature example should be posted to the
[user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -72,20 +53,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/examples-sampling/README.md
b/commons-rng-examples/examples-sampling/README.md
index fe5ee170..d469548b 100644
--- a/commons-rng-examples/examples-sampling/README.md
+++ b/commons-rng-examples/examples-sampling/README.md
@@ -17,30 +17,12 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
-Sampling example
+Apache Commons RNG Examples Sampling Utilities
===================
Application for calling external tools that perform stringent uniformity tests.
@@ -50,20 +32,19 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-examples/commons-rng-examples-sampling/apidocs/)
can be browsed.
-Questions related to the usage of Sampling example should be posted to the
[user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -72,20 +53,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-examples/examples-stress/README.md
b/commons-rng-examples/examples-stress/README.md
index a5e6e1a4..0277b685 100644
--- a/commons-rng-examples/examples-stress/README.md
+++ b/commons-rng-examples/examples-stress/README.md
@@ -17,30 +17,12 @@
<!---
+======================================================================+
|**** ****|
- |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
- |**** DO NOT EDIT DIRECTLY ****|
+ |**** This file is ADAPTED from the README generated by the ****|
+ |**** commons build plugin and must be edited ****|
|**** ****|
+======================================================================+
- | TEMPLATE FILE: readme-md-template.md |
- | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
- +======================================================================+
- | |
- | 1) Re-generate using: mvn commons-build: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>rng</commons.componentid> |
- | <commons.release.version>1.2</commons.release.version> |
- | </properties> |
- | |
- +======================================================================+
--->
-Stress test example
+Apache Commons RNG Examples Stress Utilities
===================
Application for calling external tools that perform stringent uniformity tests.
@@ -50,20 +32,19 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-examples/commons-rng-examples-stress/apidocs/)
can be browsed.
-Questions related to the usage of Stress test example should be posted to the
[user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting the latest release
+--------------------------
You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-rng/download_rng.cgi).
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -72,20 +53,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-integration/README.md
b/commons-rng-integration/README.md
index 5a04fb0b..2f52466a 100644
--- a/commons-rng-integration/README.md
+++ b/commons-rng-integration/README.md
@@ -25,43 +25,25 @@
Apache Commons RNG Integration Tests
===================
-Integration tests to validate an application referencing multiple Apache
Commons RNG artifacts
+Integration tests to validate an application referencing multiple Apache
Commons RNG artifacts.
Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-Questions related to the usage of Apache Commons RNG Sampling should be posted
to the [user mailing list][ml].
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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 and use
-the Bill of Materials (BOM) for dependency management:
-
-```xml
-<dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.apache.commons</groupId>
- <artifactId>commons-rng-bom</artifactId>
- <version>1.5</version>
- <type>pom</type>
- <scope>import</scope>
- </dependency>
- </dependencies>
-</dependencyManagement>
-```
-
-
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -70,20 +52,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-sampling/README.md b/commons-rng-sampling/README.md
index f740f1cf..76e56d07 100644
--- a/commons-rng-sampling/README.md
+++ b/commons-rng-sampling/README.md
@@ -34,7 +34,7 @@
| 3) Example Properties |
| |
| <properties> |
- | <commons.componentid>rng</commons.componentid> |
+ | <commons.componentid>math</commons.componentid> |
| <commons.release.version>1.2</commons.release.version> |
| </properties> |
| |
@@ -43,10 +43,10 @@
Apache Commons RNG Sampling
===================
-[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-rng)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-sampling/)
-[](https://javadoc.io/doc/org.apache.commons/commons-rng-sampling/1.5)
+[](https://javadoc.io/doc/org.apache.commons/commons-rng-sampling/1.6)
The Apache Commons RNG Sampling module provides samplers
for various distributions.
@@ -55,11 +55,11 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-sampling/apidocs/)
can be browsed.
-Questions related to the usage of Apache Commons RNG Sampling should be posted
to the [user mailing list][ml].
+The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-sampling/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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:
@@ -68,17 +68,25 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-rng-sampling</artifactId>
- <version>1.5</version>
+ <version>1.6</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -87,20 +95,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
diff --git a/commons-rng-simple/README.md b/commons-rng-simple/README.md
index 4c621dad..cbc85040 100644
--- a/commons-rng-simple/README.md
+++ b/commons-rng-simple/README.md
@@ -34,7 +34,7 @@
| 3) Example Properties |
| |
| <properties> |
- | <commons.componentid>rng</commons.componentid> |
+ | <commons.componentid>math</commons.componentid> |
| <commons.release.version>1.2</commons.release.version> |
| </properties> |
| |
@@ -43,10 +43,10 @@
Apache Commons RNG Simple
===================
-[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-rng/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-rng)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-simple/)
-[](https://javadoc.io/doc/org.apache.commons/commons-rng-simple/1.5)
+[](https://javadoc.io/doc/org.apache.commons/commons-rng-simple/1.6)
Simple API for instantiating random numbers generators.
@@ -54,11 +54,11 @@ Documentation
-------------
More information can be found on the [Apache Commons RNG
homepage](https://commons.apache.org/proper/commons-rng).
-The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-simple/apidocs/)
can be browsed.
-Questions related to the usage of Apache Commons RNG Simple should be posted
to the [user mailing list][ml].
+The
[Javadoc](https://commons.apache.org/proper/commons-rng/commons-rng-simple/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons RNG should be posted to the
[user mailing list](https://commons.apache.org/mail-lists.html).
-Where can I get the latest release?
------------------------------------
+Getting 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:
@@ -67,17 +67,25 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-rng-simple</artifactId>
- <version>1.5</version>
+ <version>1.6</version>
</dependency>
```
+Building
+--------
+
+Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
+The required Java version is found in the `pom.xml` as the
`maven.compiler.source` property.
+
+From a command shell, run `mvn` without arguments to invoke the default Maven
goal to run all tests and checks.
+
Contributing
------------
-We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+We accept Pull Requests via GitHub. The [developer mailing
list](https://commons.apache.org/mail-lists.html) 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.
++ Respect the existing code style for each file.
+ 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```.
@@ -86,20 +94,23 @@ You can learn more about contributing via GitHub in our
[contribution guidelines
License
-------
-This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+This code is licensed under the [Apache License
v2](https://www.apache.org/licenses/LICENSE-2.0).
See the `NOTICE` file for required notices and attributions.
-Donations
----------
-You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons RNG? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support
development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG)
++ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
-+ `#apache-commons` IRC channel on `irc.freenode.org`
-[ml]:https://commons.apache.org/mail-lists.html
+Apache Commons Components
+-------------------------
+
+Please see the [list of components](https://commons.apache.org/components.html)
