You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2020/04/02 09:47:13 UTC
[commons-numbers] 01/02: Updated README.md
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-numbers.git
commit 2b01d3ca6f9484a17e9c8c368ca3060f70d3e6d9
Author: aherbert <ah...@apache.org>
AuthorDate: Thu Apr 2 10:32:06 2020 +0100
Updated README.md
Regenerated with commons build plugin.
Modified for multi-module project:
Top level README to contain javadoc links for all modules and maven
examples for a few modules.
Module README requires an updated javadoc url and change of title to
remove the module name suffix from 'Apache Commons Numbers' where
appropriate.
---
README.md | 39 ++++++++++++++++++++-----------
commons-numbers-angle/README.md | 25 +++++++++++++-------
commons-numbers-arrays/README.md | 27 +++++++++++++--------
commons-numbers-combinatorics/README.md | 25 +++++++++++++-------
commons-numbers-complex-streams/README.md | 16 ++++++-------
commons-numbers-complex/README.md | 25 +++++++++++++-------
commons-numbers-core/README.md | 25 +++++++++++++-------
commons-numbers-field/README.md | 25 +++++++++++++-------
commons-numbers-fraction/README.md | 25 +++++++++++++-------
commons-numbers-gamma/README.md | 25 +++++++++++++-------
commons-numbers-primes/README.md | 25 +++++++++++++-------
commons-numbers-quaternion/README.md | 25 +++++++++++++-------
commons-numbers-rootfinder/README.md | 25 +++++++++++++-------
13 files changed, 211 insertions(+), 121 deletions(-)
diff --git a/README.md b/README.md
index b439bc0..a5f6d90 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,19 +43,30 @@
Apache Commons Numbers
===================
-[](https://travis-ci.org/apache/commons-numbers)
-[](https://coveralls.io/github/apache/commons-numbers?branch=master)
-[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers/)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
-[](https://lgtm.com/projects/g/apache/commons-numbers/context:java)
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-parent/)
The Apache Commons Numbers project provides number types and utilities.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The Javadoc for each of the modules can be browsed:
+
+- [Commons Numbers Core](https://commons.apache.org/proper/commons-numbers/commons-numbers-core/apidocs/)
+- [Commons Numbers Complex](https://commons.apache.org/proper/commons-numbers/commons-numbers-complex/apidocs/)
+- [Commons Numbers Primes](https://commons.apache.org/proper/commons-numbers/commons-numbers-primes/apidocs/)
+- [Commons Numbers Quaternion](https://commons.apache.org/proper/commons-numbers/commons-numbers-quaternion/apidocs/)
+- [Commons Numbers Fraction](https://commons.apache.org/proper/commons-numbers/commons-numbers-fraction/apidocs/)
+- [Commons Numbers Angle](https://commons.apache.org/proper/commons-numbers/commons-numbers-angle/apidocs/)
+- [Commons Numbers Gamma](https://commons.apache.org/proper/commons-numbers/commons-numbers-gamma/apidocs/)
+- [Commons Numbers Combinatorics](https://commons.apache.org/proper/commons-numbers/commons-numbers-combinatorics/apidocs/)
+- [Commons Numbers Arrays](https://commons.apache.org/proper/commons-numbers/commons-numbers-arrays/apidocs/)
+- [Commons Numbers Field](https://commons.apache.org/proper/commons-numbers/commons-numbers-field/apidocs/)
+- [Commons Numbers RootFinder](https://commons.apache.org/proper/commons-numbers/commons-numbers-rootfinder/apidocs/)
+
Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
@@ -67,7 +78,7 @@ Alternatively you can pull it from the central Maven repositories:
```xml
<dependency>
<groupId>org.apache.commons</groupId>
- <artifactId>commons-numbers</artifactId>
+ <artifactId>commons-numbers-parent</artifactId>
<version>1.0</version>
</dependency>
```
@@ -75,7 +86,7 @@ Alternatively you can pull it from the central Maven repositories:
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 +98,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 +110,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/NUMBERS)
+ [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-numbers-angle/README.md b/commons-numbers-angle/README.md
index 3802293..56ed534 100644
--- a/commons-numbers-angle/README.md
+++ b/commons-numbers-angle/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Angle
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-angle/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-angle/1.0)
+
Utilities related to the concept of angle.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Angle should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-angle/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Angle? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-arrays/README.md b/commons-numbers-arrays/README.md
index 7f6176a..464884c 100644
--- a/commons-numbers-arrays/README.md
+++ b/commons-numbers-arrays/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Arrays
===================
-Basic utilities.
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-arrays/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-arrays/1.0)
+
+Array utilities.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Arrays should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-arrays/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Arrays? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-combinatorics/README.md b/commons-numbers-combinatorics/README.md
index cbbf01f..3e21c4c 100644
--- a/commons-numbers-combinatorics/README.md
+++ b/commons-numbers-combinatorics/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Combinatorics
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-combinatorics/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-combinatorics/1.0)
+
Combinatorics utilities such as factorial and binomial coefficients.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Combinatorics should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-combinatorics/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Combinatorics? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-complex-streams/README.md b/commons-numbers-complex-streams/README.md
index 9d8f917..439bcab 100644
--- a/commons-numbers-complex-streams/README.md
+++ b/commons-numbers-complex-streams/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,19 +43,19 @@
Apache Commons Numbers Complex Streams
===================
-[](https://travis-ci.org/apache/commons-numbers-complex-streams)
-[](https://coveralls.io/r/apache/commons-numbers-complex-streams)
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-complex-streams/)
-[](http://www.apache.org/licenses/LICENSE-2.0.html)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-complex-streams/1.0)
Arrays, streams and collections of complex numbers.
Documentation
-------------
-More information can be found on the [Apache Commons Numbers Complex Streams homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Complex Streams should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-complex-streams/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -92,7 +92,7 @@ See the `NOTICE.txt` file for required notices and attributions.
Donations
---------
-You like Apache Commons Numbers Complex Streams? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
diff --git a/commons-numbers-complex/README.md b/commons-numbers-complex/README.md
index 582b7ce..54e4abd 100644
--- a/commons-numbers-complex/README.md
+++ b/commons-numbers-complex/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Complex
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-complex/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-complex/1.0)
+
Complex numbers.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Complex should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-complex/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Complex? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-core/README.md b/commons-numbers-core/README.md
index 0701bed..0bce34d 100644
--- a/commons-numbers-core/README.md
+++ b/commons-numbers-core/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Core
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-core/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-core/1.0)
+
Basic utilities.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Core should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-core/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Core? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-field/README.md b/commons-numbers-field/README.md
index aef0c98..feccc00 100644
--- a/commons-numbers-field/README.md
+++ b/commons-numbers-field/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Field
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-field/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-field/1.0)
+
Utilities related to the concept of field.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Field should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-field/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Field? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-fraction/README.md b/commons-numbers-fraction/README.md
index b9cd6e2..287b26f 100644
--- a/commons-numbers-fraction/README.md
+++ b/commons-numbers-fraction/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Fraction
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-fraction/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-fraction/1.0)
+
Fraction utilities.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Fraction should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-fraction/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Fraction? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-gamma/README.md b/commons-numbers-gamma/README.md
index 1f843c5..f46bb04 100644
--- a/commons-numbers-gamma/README.md
+++ b/commons-numbers-gamma/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Gamma
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-gamma/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-gamma/1.0)
+
Gamma family of functions.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Gamma should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-gamma/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Gamma? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-primes/README.md b/commons-numbers-primes/README.md
index ac17265..15017da 100644
--- a/commons-numbers-primes/README.md
+++ b/commons-numbers-primes/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Primes
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-primes/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-primes/1.0)
+
Utilities related to prime numbers.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Primes should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-primes/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Primes? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-quaternion/README.md b/commons-numbers-quaternion/README.md
index ab9f829..4c94431 100644
--- a/commons-numbers-quaternion/README.md
+++ b/commons-numbers-quaternion/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Quaternion
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-quaternion/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-quaternion/1.0)
+
Quaternion numbers.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Quaternion should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-quaternion/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Quaternion? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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-numbers-rootfinder/README.md b/commons-numbers-rootfinder/README.md
index aa902d6..9dde65a 100644
--- a/commons-numbers-rootfinder/README.md
+++ b/commons-numbers-rootfinder/README.md
@@ -25,7 +25,7 @@
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+
| |
- | 1) Re-generate using: mvn commons:readme-md |
+ | 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) |
@@ -43,14 +43,19 @@
Apache Commons Numbers Root Finder
===================
+[](https://travis-ci.org/apache/commons-numbers)
+[](https://coveralls.io/r/apache/commons-numbers)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-numbers-rootfinder/)
+[](https://javadoc.io/doc/org.apache.commons/commons-numbers-rootfinder/1.0)
+
Root finding utilities.
Documentation
-------------
-More information can be found on the [homepage](https://commons.apache.org/proper/commons-numbers).
-The [JavaDoc](https://commons.apache.org/proper/commons-numbers/javadocs/api-release) can be browsed.
-Questions related to the usage of Apache Commons Numbers Root Finder should be posted to the [user mailing list][ml].
+More information can be found on the [Apache Commons Numbers homepage](https://commons.apache.org/proper/commons-numbers).
+The [Javadoc](https://commons.apache.org/proper/commons-numbers/commons-numbers-rootfinder/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Numbers should be posted to the [user mailing list][ml].
Where can I get the latest release?
-----------------------------------
@@ -69,7 +74,7 @@ Alternatively you can pull it from the central Maven repositories:
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.
@@ -81,18 +86,20 @@ 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
---------
-You like Apache Commons Numbers Root Finder? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
+You like Apache Commons Numbers? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
Additional Resources
--------------------
+ [Apache Commons Homepage](https://commons.apache.org/)
-+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/NUMBERS)
+ [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