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-statistics.git
commit c34603c4820cca73261f748744d1e8ac1ef7104d
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Tue Aug 20 11:59:09 2024 +0100
Update README following release of 1.1
---
README.md | 58 ++++++++++++++++------
commons-statistics-bom/README.md | 35 ++++++++-----
commons-statistics-descriptive/README.md | 45 ++++++++++-------
commons-statistics-distribution/README.md | 45 ++++++++++-------
.../README.md | 44 +++++++++-------
commons-statistics-examples/README.md | 36 +++++++++-----
.../examples-distribution/README.md | 36 +++++++++-----
commons-statistics-examples/examples-jmh/README.md | 37 +++++++++-----
commons-statistics-inference/README.md | 44 +++++++++-------
commons-statistics-ranking/README.md | 44 +++++++++-------
commons-statistics-regression/README.md | 40 +++++++++------
11 files changed, 296 insertions(+), 168 deletions(-)
diff --git a/README.md b/README.md
index d0db89d..f587bc3 100644
--- a/README.md
+++ b/README.md
@@ -43,11 +43,10 @@
Apache Commons Statistics
===================
-[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-statistics)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-bom/?gav=true)
[](https://sonarcloud.io/dashboard?id=commons-statistics)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-distribution/)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
The Apache Commons Statistics project provides tools for statistics.
@@ -55,30 +54,54 @@ Documentation
-------------
More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-distribution/javadocs/api-1.0)
can be browsed.
+The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-docs/apidocs)
for each of the modules can be browsed:
+
+- [Commons Statistics
Descriptive](https://commons.apache.org/proper/commons-statistics/commons-statistics-descriptive/apidocs/)
+- [Commons Statistics
Distribution](https://commons.apache.org/proper/commons-statistics/commons-statistics-distribution/apidocs/)
+- [Commons Statistics
Inference](https://commons.apache.org/proper/commons-statistics/commons-statistics-inference/apidocs/)
+- [Commons Statistics
Ranking](https://commons.apache.org/proper/commons-statistics/commons-statistics-ranking/apidocs/)
+
Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
-Alternatively, you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories, for
example:
```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-statistics-descriptive</artifactId>
+ <version>1.1</version>
+</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-statistics-distribution</artifactId>
- <version>1.0</version>
+ <version>1.1</version>
+</dependency>
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-statistics-inference</artifactId>
+ <version>1.1</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 +110,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 Statistics? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-bom/README.md b/commons-statistics-bom/README.md
index a8e2881..1da1eea 100644
--- a/commons-statistics-bom/README.md
+++ b/commons-statistics-bom/README.md
@@ -31,10 +31,11 @@ Documentation
-------------
More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
-Questions related to the usage of Apache Commons Statistics Sampling should be
posted to the [user mailing list][ml].
+The [Javadoc](https://commons.apache.org/proper/commons-statistics/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
Alternatively, you can pull it from the central Maven repositories and use
@@ -46,7 +47,7 @@ the Bill of Materials (BOM) for dependency management:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-statistics-bom</artifactId>
- <version>1.0</version>
+ <version>1.1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
@@ -54,14 +55,21 @@ the Bill of Materials (BOM) for dependency management:
</dependencyManagement>
```
+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```.
@@ -70,20 +78,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 Statistics? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-descriptive/README.md
b/commons-statistics-descriptive/README.md
index 0d7f74c..7904b0e 100644
--- a/commons-statistics-descriptive/README.md
+++ b/commons-statistics-descriptive/README.md
@@ -43,26 +43,24 @@
Apache Commons Statistics Descriptive
===================
-[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-statistics)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-descriptive/)
-[](https://javadoc.io/doc/org.apache.commons/commons-statistics-descriptive/1.1)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-descriptive/?gav=true)
Descriptive statistics.
Documentation
-------------
-More information can be found on the [Apache Commons Statistics Descriptive
homepage](https://commons.apache.org/proper/commons-statistics).
-The [Javadoc](https://commons.apache.org/proper/commons-statistics/apidocs)
can be browsed.
-Questions related to the usage of Apache Commons Statistics Descriptive should
be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
+The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-descriptive/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
-Alternatively you can pull it from the central Maven repositories:
+Alternatively, you can pull it from the central Maven repositories:
```xml
<dependency>
@@ -72,13 +70,21 @@ Alternatively you can pull it from the central Maven
repositories:
</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 +93,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 Statistics Descriptive? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-distribution/README.md
b/commons-statistics-distribution/README.md
index 6ba6670..165ca91 100644
--- a/commons-statistics-distribution/README.md
+++ b/commons-statistics-distribution/README.md
@@ -43,23 +43,21 @@
Apache Commons Statistics Distribution
===================
-[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-statistics)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-distribution/)
-[](https://javadoc.io/doc/org.apache.commons/commons-statistics-distribution/1.0)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-distribution/?gav=true)
Statistical distributions.
Documentation
-------------
-More information can be found on the [Apache Commons Statistics Distribution
Homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-distribution/javadocs/api-1.0)
can be browsed.
-Questions related to the usage of Apache Commons Statistics Distribution
should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
+The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-distribution/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
Alternatively, you can pull it from the central Maven repositories:
@@ -68,17 +66,25 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-statistics-distribution</artifactId>
- <version>1.0</version>
+ <version>1.1</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 +93,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 Statistics Distribution? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-examples/README.md
b/commons-statistics-docs/README.md
similarity index 76%
copy from commons-statistics-examples/README.md
copy to commons-statistics-docs/README.md
index 0a6ac38..0933d6b 100644
--- a/commons-statistics-examples/README.md
+++ b/commons-statistics-docs/README.md
@@ -40,32 +40,39 @@
| |
+======================================================================+
--->
-Apache Commons Statistics
+Apache Commons Statistics Documentation
===================
-Examples of use of the "Commons Statistics" 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.
+[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
+
+Aggregator module to genenerate Apache Commons Statistics documentation.
Documentation
-------------
More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/javadocs/api-release)
can be browsed.
-Questions related to the usage of Apache Commons Statistics should be posted
to the [user mailing list][ml].
+The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-docs/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
+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```.
@@ -74,20 +81,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 Statistics? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-examples/README.md
b/commons-statistics-examples/README.md
index 0a6ac38..5d81ddc 100644
--- a/commons-statistics-examples/README.md
+++ b/commons-statistics-examples/README.md
@@ -40,7 +40,7 @@
| |
+======================================================================+
--->
-Apache Commons Statistics
+Apache Commons Statistics Examples
===================
Examples of use of the "Commons Statistics" library.
@@ -52,20 +52,27 @@ Documentation
-------------
More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/javadocs/api-release)
can be browsed.
-Questions related to the usage of Apache Commons Statistics should be posted
to the [user mailing list][ml].
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
+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```.
@@ -74,20 +81,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 Statistics? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-examples/examples-distribution/README.md
b/commons-statistics-examples/examples-distribution/README.md
index b5286b8..2798349 100644
--- a/commons-statistics-examples/examples-distribution/README.md
+++ b/commons-statistics-examples/examples-distribution/README.md
@@ -40,7 +40,7 @@
| |
+======================================================================+
--->
-Apache Commons Statistics
+Apache Commons Statistics Distribution Utilities
===================
Application for calling the distributions defined in Commons Statistics.
@@ -50,20 +50,27 @@ Documentation
-------------
More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/javadocs/api-release)
can be browsed.
-Questions related to the usage of Apache Commons Statistics should be posted
to the [user mailing list][ml].
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
+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```.
@@ -72,20 +79,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 Statistics? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-examples/examples-jmh/README.md
b/commons-statistics-examples/examples-jmh/README.md
index bb2d0d3..a5005cc 100644
--- a/commons-statistics-examples/examples-jmh/README.md
+++ b/commons-statistics-examples/examples-jmh/README.md
@@ -40,7 +40,7 @@
| |
+======================================================================+
--->
-Apache Commons Numbers JMH Benchmark
+Apache Commons Statistics JMH Benchmark
===================
Code for running JMH benchmarks that assess performance.
@@ -50,19 +50,29 @@ Documentation
-------------
More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
-Questions related to the usage of Apache Commons Statistics should be posted
to the [user mailing list][ml].
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
+Alternatively, you can pull it from the central Maven repositories:
+
+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```.
@@ -71,20 +81,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 Statistics? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-inference/README.md
b/commons-statistics-inference/README.md
index 1ca63f4..1fd8ec9 100644
--- a/commons-statistics-inference/README.md
+++ b/commons-statistics-inference/README.md
@@ -43,22 +43,21 @@
Apache Commons Statistics Inference
===================
-[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-statistics)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-inference/)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-inference/?gav=true)
Statistical hypothesis testing.
Documentation
-------------
-More information can be found on the [Apache Commons Statistics Inference
Homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/javadocs/api-release)
can be browsed.
-Questions related to the usage of Apache Commons Statistics Inference should
be posted to the [user mailing list][ml].
+inferenceMore information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
+The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-inference/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
Alternatively, you can pull it from the central Maven repositories:
@@ -67,17 +66,25 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-statistics-inference</artifactId>
- <version>1.0</version>
+ <version>1.1</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 +93,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 Statistics Inference? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-ranking/README.md
b/commons-statistics-ranking/README.md
index b7ea063..8b32c22 100644
--- a/commons-statistics-ranking/README.md
+++ b/commons-statistics-ranking/README.md
@@ -43,22 +43,21 @@
Apache Commons Statistics Ranking
===================
-[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-statistics)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-ranking/)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-ranking/?gav=true)
Statistical rank transformations.
Documentation
-------------
-More information can be found on the [Apache Commons Statistics Ranking
Homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/javadocs/api-release)
can be browsed.
-Questions related to the usage of Apache Commons Statistics Ranking should be
posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
+The
[Javadoc](https://commons.apache.org/proper/commons-statistics/commons-statistics-ranking/apidocs)
can be browsed.
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
Alternatively, you can pull it from the central Maven repositories:
@@ -67,17 +66,25 @@ Alternatively, you can pull it from the central Maven
repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-statistics-ranking</artifactId>
- <version>1.0</version>
+ <version>1.1</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 +93,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 Statistics Ranking? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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-statistics-regression/README.md
b/commons-statistics-regression/README.md
index decb476..7cbfc1a 100644
--- a/commons-statistics-regression/README.md
+++ b/commons-statistics-regression/README.md
@@ -43,30 +43,37 @@
Apache Commons Statistics Regression
===================
-[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
+[](https://github.com/apache/commons-statistics/actions/workflows/maven.yml)
[](https://app.codecov.io/gh/apache/commons-statistics)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-statistics-regression/?gav=true)
Statistical regressions.
Documentation
-------------
-More information can be found on the [Apache Commons Statistics Regression
Homepage](https://commons.apache.org/proper/commons-statistics).
-The
[Javadoc](https://commons.apache.org/proper/commons-statistics/javadocs/api-release)
can be browsed.
-Questions related to the usage of Apache Commons Statistics Regression should
be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Statistics
homepage](https://commons.apache.org/proper/commons-statistics).
+Questions related to the usage of Apache Commons Statistics 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-statistics/download_statistics.cgi).
+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```.
@@ -75,20 +82,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 Statistics Regression? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+Donating
+--------
+You like Apache Commons Statistics? 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/STATISTICS)
++ [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)
