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 f7d09efa808ada68762e7a81581d38fcc64182df Author: Alex Herbert <aherb...@apache.org> AuthorDate: Sat Feb 16 11:30:36 2019 +0000 Updated the README.md using the commons build plugin. --- README.md | 33 +++++++++++----------- commons-rng-client-api/README.md | 8 +++--- commons-rng-core/README.md | 12 +++++--- commons-rng-examples/README.md | 14 +++++---- commons-rng-examples/examples-jmh/README.md | 16 +++++------ commons-rng-examples/examples-jpms/README.md | 16 +++++------ .../examples-jpms/jpms-app/README.md | 8 +++--- .../examples-jpms/jpms-lib/README.md | 8 +++--- commons-rng-examples/examples-quadrature/README.md | 16 +++++------ commons-rng-examples/examples-sampling/README.md | 16 +++++------ commons-rng-examples/examples-stress/README.md | 16 +++++------ commons-rng-sampling/README.md | 8 +++--- commons-rng-simple/README.md | 8 +++--- 13 files changed, 93 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 485739d..71ec933 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,8 @@ | 3) Example Properties | | | | <properties> | - | <commons.componentid>rng</commons.componentid> | - | <commons.release.version>1.0</commons.release.version> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | | </properties> | | | +======================================================================+ @@ -43,19 +43,18 @@ Apache Commons RNG =================== -[](https://travis-ci.org/apache/commons-rng) -[](https://coveralls.io/github/apache/commons-rng?branch=master) -[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-simple/) -[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-sampling/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-parent/) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-parent/1.2) -The Apache Commons RNG project provides Java implementations of pseudo-random numbers generators. +The Apache Commons RNG project provides pure-Java implementation of pseudo-random generators. Documentation ------------- -More information can be found on the [homepage](https://commons.apache.org/proper/commons-rng). -The [Javadoc](https://commons.apache.org/proper/commons-rng/apidocs) can be browsed. +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/javadocs/api-release) can be browsed. Questions related to the usage of Apache Commons RNG should be posted to the [user mailing list][ml]. Where can I get the latest release? @@ -67,15 +66,15 @@ Alternatively you can pull it from the central Maven repositories: ```xml <dependency> <groupId>org.apache.commons</groupId> - <artifactId>commons-rng</artifactId> - <version>1.1</version> + <artifactId>commons-rng-parent</artifactId> + <version>1.2</version> </dependency> ``` Contributing ------------ -We accept PRs 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][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. @@ -87,7 +86,9 @@ You can learn more about contributing via GitHub in our [contribution guidelines License ------- -Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt). +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 --------- @@ -97,8 +98,8 @@ Additional Resources -------------------- + [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/RNG) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ #apachecommons IRC channel on freenode.org ++ `#apache-commons` IRC channel on `irc.freenode.org` [ml]:https://commons.apache.org/mail-lists.html diff --git a/commons-rng-client-api/README.md b/commons-rng-client-api/README.md index c9dc72b..8aa3fdd 100644 --- a/commons-rng-client-api/README.md +++ b/commons-rng-client-api/README.md @@ -43,10 +43,10 @@ Apache Commons RNG Client API =================== -[](https://travis-ci.org/apache/commons-rng-client-api) -[](https://coveralls.io/r/apache/commons-rng-client-api) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-client-api/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-client-api/1.2) API for client code that uses random numbers generators. @@ -67,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-client-api</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` diff --git a/commons-rng-core/README.md b/commons-rng-core/README.md index c82c007..b377b1d 100644 --- a/commons-rng-core/README.md +++ b/commons-rng-core/README.md @@ -43,12 +43,16 @@ Apache Commons RNG Core =================== -[](https://travis-ci.org/apache/commons-rng-core) -[](https://coveralls.io/r/apache/commons-rng-core) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-core/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-core/1.2) Pure Java implementations of random numbers generator algorithms. + Code in this module should not be used directly by applications; please use + the client interface defined in module "commons-rng-client-api" and the factory + methods defined in module "commons-rng-simple". In a future release, modularization + may be enforced through JPMS access restrictions. Documentation ------------- @@ -67,7 +71,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-core</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` diff --git a/commons-rng-examples/README.md b/commons-rng-examples/README.md index 2bf3303..78b41cf 100644 --- a/commons-rng-examples/README.md +++ b/commons-rng-examples/README.md @@ -43,13 +43,15 @@ Apache Commons RNG Examples =================== -[](https://travis-ci.org/apache/commons-rng-examples) -[](https://coveralls.io/r/apache/commons-rng-examples) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples/1.2) -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. +Examples of use of the "Commons RNG" library. + Codes in this module and its sub-modules are not part of the library. + They provide checking, benchmarking tools to enhance the documentation + and to help ensure correctness of the implementations. Documentation ------------- @@ -68,7 +70,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` diff --git a/commons-rng-examples/examples-jmh/README.md b/commons-rng-examples/examples-jmh/README.md index d3d13c7..3993f28 100644 --- a/commons-rng-examples/examples-jmh/README.md +++ b/commons-rng-examples/examples-jmh/README.md @@ -40,13 +40,13 @@ | | +======================================================================+ ---> -Apache Commons RNG JMH Benchmark +JMH Benchmark =================== -[](https://travis-ci.org/apache/commons-rng-examples-jmh) -[](https://coveralls.io/r/apache/commons-rng-examples-jmh) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jmh/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples-jmh/1.2) Code for running JMH benchmarks that assess the performance of the generators. Code in this module is not part of the public API. @@ -54,9 +54,9 @@ Code for running JMH benchmarks that assess the performance of the generators. Documentation ------------- -More information can be found on the [Apache Commons RNG JMH Benchmark homepage](https://commons.apache.org/proper/commons-rng). +More information can be found on the [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 Benchmark should be posted to the [user mailing list][ml]. +Questions related to the usage of JMH Benchmark should be posted to the [user mailing list][ml]. Where can I get the latest release? ----------------------------------- @@ -68,7 +68,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples-jmh</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` @@ -93,7 +93,7 @@ See the `NOTICE.txt` file for required notices and attributions. Donations --------- -You like Apache Commons RNG JMH Benchmark? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. +You like JMH Benchmark? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Additional Resources -------------------- diff --git a/commons-rng-examples/examples-jpms/README.md b/commons-rng-examples/examples-jpms/README.md index a3a9175..29a4cf7 100644 --- a/commons-rng-examples/examples-jpms/README.md +++ b/commons-rng-examples/examples-jpms/README.md @@ -40,22 +40,22 @@ | | +======================================================================+ ---> -Apache Commons RNG Integration +JPMS Integration test =================== -[](https://travis-ci.org/apache/commons-rng-examples-jpms) -[](https://coveralls.io/r/apache/commons-rng-examples-jpms) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jpms/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples-jpms/1.2) 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 Integration test 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 Integration test should be posted to the [user mailing list][ml]. Where can I get the latest release? ----------------------------------- @@ -67,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples-jpms</artifactId> - <version>1.0</version> + <version>1.2</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 Integration test? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Additional Resources -------------------- diff --git a/commons-rng-examples/examples-jpms/jpms-app/README.md b/commons-rng-examples/examples-jpms/jpms-app/README.md index e6c5d2d..3119e76 100644 --- a/commons-rng-examples/examples-jpms/jpms-app/README.md +++ b/commons-rng-examples/examples-jpms/jpms-app/README.md @@ -43,10 +43,10 @@ JPMS module example (application) =================== -[](https://travis-ci.org/apache/commons-rng-examples-jpms-app) -[](https://coveralls.io/r/apache/commons-rng-examples-jpms-app) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jpms-app/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples-jpms-app/1.2) Testing JPMS. Code in this module is not part of the public API. @@ -67,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples-jpms-app</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` diff --git a/commons-rng-examples/examples-jpms/jpms-lib/README.md b/commons-rng-examples/examples-jpms/jpms-lib/README.md index 3818a11..7c35906 100644 --- a/commons-rng-examples/examples-jpms/jpms-lib/README.md +++ b/commons-rng-examples/examples-jpms/jpms-lib/README.md @@ -43,10 +43,10 @@ JPMS module example (library) =================== -[](https://travis-ci.org/apache/commons-rng-examples-jpms-lib) -[](https://coveralls.io/r/apache/commons-rng-examples-jpms-lib) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-jpms-lib/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples-jpms-lib/1.2) Testing JPMS. Code in this module is not part of the public API. @@ -67,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples-jpms-lib</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` diff --git a/commons-rng-examples/examples-quadrature/README.md b/commons-rng-examples/examples-quadrature/README.md index 040a51c..f233691 100644 --- a/commons-rng-examples/examples-quadrature/README.md +++ b/commons-rng-examples/examples-quadrature/README.md @@ -40,13 +40,13 @@ | | +======================================================================+ ---> -Apache Commons RNG Quadrature Test Example +Quadrature example =================== -[](https://travis-ci.org/apache/commons-rng-examples-quadrature) -[](https://coveralls.io/r/apache/commons-rng-examples-quadrature) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-quadrature/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples-quadrature/1.2) Application for calling external tools that perform stringent uniformity tests. Code in this module is not part of the public API. @@ -54,9 +54,9 @@ Application for calling external tools that perform stringent uniformity tests. Documentation ------------- -More information can be found on the [Apache Commons RNG Quadrature Test Example homepage](https://commons.apache.org/proper/commons-rng). +More information can be found on the [Quadrature 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]. +Questions related to the usage of Quadrature example should be posted to the [user mailing list][ml]. Where can I get the latest release? ----------------------------------- @@ -68,7 +68,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples-quadrature</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` @@ -93,7 +93,7 @@ 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. +You like Quadrature example? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Additional Resources -------------------- diff --git a/commons-rng-examples/examples-sampling/README.md b/commons-rng-examples/examples-sampling/README.md index 591be67..e61154f 100644 --- a/commons-rng-examples/examples-sampling/README.md +++ b/commons-rng-examples/examples-sampling/README.md @@ -40,13 +40,13 @@ | | +======================================================================+ ---> -Apache Commons RNG Sampling Test Example +Sampling example =================== -[](https://travis-ci.org/apache/commons-rng-examples-sampling) -[](https://coveralls.io/r/apache/commons-rng-examples-sampling) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-sampling/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples-sampling/1.2) Application for calling external tools that perform stringent uniformity tests. Code in this module is not part of the public API. @@ -54,9 +54,9 @@ Application for calling external tools that perform stringent uniformity tests. Documentation ------------- -More information can be found on the [Apache Commons RNG Sampling Test Example homepage](https://commons.apache.org/proper/commons-rng). +More information can be found on the [Sampling 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]. +Questions related to the usage of Sampling example should be posted to the [user mailing list][ml]. Where can I get the latest release? ----------------------------------- @@ -68,7 +68,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples-sampling</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` @@ -93,7 +93,7 @@ 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. +You like Sampling example? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Additional Resources -------------------- diff --git a/commons-rng-examples/examples-stress/README.md b/commons-rng-examples/examples-stress/README.md index e274f1e..27b38ab 100644 --- a/commons-rng-examples/examples-stress/README.md +++ b/commons-rng-examples/examples-stress/README.md @@ -40,13 +40,13 @@ | | +======================================================================+ ---> -Apache Commons RNG Stress Test Example +Stress test example =================== -[](https://travis-ci.org/apache/commons-rng-examples-stress) -[](https://coveralls.io/r/apache/commons-rng-examples-stress) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-examples-stress/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-examples-stress/1.2) Application for calling external tools that perform stringent uniformity tests. Code in this module is not part of the public API. @@ -54,9 +54,9 @@ Application for calling external tools that perform stringent uniformity tests. Documentation ------------- -More information can be found on the [Apache Commons RNG Stress Test Example homepage](https://commons.apache.org/proper/commons-rng). +More information can be found on the [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]. +Questions related to the usage of Stress test example should be posted to the [user mailing list][ml]. Where can I get the latest release? ----------------------------------- @@ -68,7 +68,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-examples-stress</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` @@ -93,7 +93,7 @@ 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. +You like Stress test example? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Additional Resources -------------------- diff --git a/commons-rng-sampling/README.md b/commons-rng-sampling/README.md index f47bb6c..1720491 100644 --- a/commons-rng-sampling/README.md +++ b/commons-rng-sampling/README.md @@ -43,10 +43,10 @@ Apache Commons RNG Sampling =================== -[](https://travis-ci.org/apache/commons-rng-sampling) -[](https://coveralls.io/r/apache/commons-rng-sampling) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-sampling/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-sampling/1.2) The Apache Commons RNG Sampling module provides samplers for various distributions. @@ -68,7 +68,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-sampling</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ``` diff --git a/commons-rng-simple/README.md b/commons-rng-simple/README.md index f1ae333..d695895 100644 --- a/commons-rng-simple/README.md +++ b/commons-rng-simple/README.md @@ -43,10 +43,10 @@ Apache Commons RNG Simple =================== -[](https://travis-ci.org/apache/commons-rng-simple) -[](https://coveralls.io/r/apache/commons-rng-simple) +[](https://travis-ci.org/apache/commons-rng) +[](https://coveralls.io/r/apache/commons-rng) [](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-rng-simple/) -[](http://www.apache.org/licenses/LICENSE-2.0.html) +[](https://javadoc.io/doc/org.apache.commons/commons-rng-simple/1.2) Simple API for instantiating random numbers generators. @@ -67,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-simple</artifactId> - <version>1.0</version> + <version>1.2</version> </dependency> ```