This is an automated email from the ASF dual-hosted git repository.
erans pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
The following commit(s) were added to refs/heads/master by this push:
new 5c3487b GEOMETRY-5: adding initial README files
new afdd744 Merge branch 'GEOMETRY-5__matt'
5c3487b is described below
commit 5c3487b47f152bddbe4af04391ca938dcb8dd5d3
Author: Matt Juntunen <matt.juntu...@hotmail.com>
AuthorDate: Sun Jun 3 00:08:33 2018 -0400
GEOMETRY-5: adding initial README files
---
README.md | 105 +++++++++++++++++++++++++++++++++++
commons-geometry-core/README.md | 105 +++++++++++++++++++++++++++++++++++
commons-geometry-enclosing/README.md | 105 +++++++++++++++++++++++++++++++++++
commons-geometry-euclidean/README.md | 105 +++++++++++++++++++++++++++++++++++
commons-geometry-hull/README.md | 105 +++++++++++++++++++++++++++++++++++
commons-geometry-spherical/README.md | 105 +++++++++++++++++++++++++++++++++++
pom.xml | 2 +-
7 files changed, 631 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d33295
--- /dev/null
+++ b/README.md
@@ -0,0 +1,105 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons Geometry
+===================
+
+[](https://travis-ci.org/apache/commons-geometry-parent)
+[](https://coveralls.io/r/apache/commons-geometry-parent)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-parent/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+The Apache Commons Geometry project provides geometric types and utilities.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Geometry
homepage](https://commons.apache.org/proper/commons-geometry).
+The
[JavaDoc](https://commons.apache.org/proper/commons-geometry/javadocs/api-release)
can be browsed.
+Questions related to the usage of Apache Commons Geometry should be posted to
the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-geometry/download_geometry.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-geometry-parent</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Geometry? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/GEOMETRY)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-geometry-core/README.md b/commons-geometry-core/README.md
new file mode 100644
index 0000000..c9c3edf
--- /dev/null
+++ b/commons-geometry-core/README.md
@@ -0,0 +1,105 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons Geometry Core
+===================
+
+[](https://travis-ci.org/apache/commons-geometry-core)
+[](https://coveralls.io/r/apache/commons-geometry-core)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Core interfaces and classes for Apache Commons Geometry.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Geometry Core
homepage](https://commons.apache.org/proper/commons-geometry).
+The
[JavaDoc](https://commons.apache.org/proper/commons-geometry/javadocs/api-release)
can be browsed.
+Questions related to the usage of Apache Commons Geometry Core should be
posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-geometry/download_geometry.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-geometry-core</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Geometry Core? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/GEOMETRY)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-geometry-enclosing/README.md
b/commons-geometry-enclosing/README.md
new file mode 100644
index 0000000..08c174a
--- /dev/null
+++ b/commons-geometry-enclosing/README.md
@@ -0,0 +1,105 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons Geometry Enclosing
+===================
+
+[](https://travis-ci.org/apache/commons-geometry-enclosing)
+[](https://coveralls.io/r/apache/commons-geometry-enclosing)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Algorithms for computing enclosing balls.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Geometry Enclosing
homepage](https://commons.apache.org/proper/commons-geometry).
+The
[JavaDoc](https://commons.apache.org/proper/commons-geometry/javadocs/api-release)
can be browsed.
+Questions related to the usage of Apache Commons Geometry Enclosing should be
posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-geometry/download_geometry.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-geometry-enclosing</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Geometry Enclosing? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/GEOMETRY)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-geometry-euclidean/README.md
b/commons-geometry-euclidean/README.md
new file mode 100644
index 0000000..658cd4f
--- /dev/null
+++ b/commons-geometry-euclidean/README.md
@@ -0,0 +1,105 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons Geometry Euclidean
+===================
+
+[](https://travis-ci.org/apache/commons-geometry-euclidean)
+[](https://coveralls.io/r/apache/commons-geometry-euclidean)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Geometric primitives for euclidean space.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Geometry Euclidean
homepage](https://commons.apache.org/proper/commons-geometry).
+The
[JavaDoc](https://commons.apache.org/proper/commons-geometry/javadocs/api-release)
can be browsed.
+Questions related to the usage of Apache Commons Geometry Euclidean should be
posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-geometry/download_geometry.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-geometry-euclidean</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Geometry Euclidean? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/GEOMETRY)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-geometry-hull/README.md b/commons-geometry-hull/README.md
new file mode 100644
index 0000000..4daa00c
--- /dev/null
+++ b/commons-geometry-hull/README.md
@@ -0,0 +1,105 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons Geometry Hull
+===================
+
+[](https://travis-ci.org/apache/commons-geometry-hull)
+[](https://coveralls.io/r/apache/commons-geometry-hull)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Algorithms for computing convex hulls.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Geometry Hull
homepage](https://commons.apache.org/proper/commons-geometry).
+The
[JavaDoc](https://commons.apache.org/proper/commons-geometry/javadocs/api-release)
can be browsed.
+Questions related to the usage of Apache Commons Geometry Hull should be
posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-geometry/download_geometry.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-geometry-hull</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Geometry Hull? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/GEOMETRY)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
diff --git a/commons-geometry-spherical/README.md
b/commons-geometry-spherical/README.md
new file mode 100644
index 0000000..3543917
--- /dev/null
+++ b/commons-geometry-spherical/README.md
@@ -0,0 +1,105 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!---
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: readme-md-template.md |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:readme-md |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | - commons.release.version (required) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | <commons.release.version>1.2</commons.release.version> |
+ | </properties> |
+ | |
+ +======================================================================+
+--->
+Apache Commons Geometry Spherical
+===================
+
+[](https://travis-ci.org/apache/commons-geometry-spherical)
+[](https://coveralls.io/r/apache/commons-geometry-spherical)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Geometric primitives for spherical space.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Geometry Spherical
homepage](https://commons.apache.org/proper/commons-geometry).
+The
[JavaDoc](https://commons.apache.org/proper/commons-geometry/javadocs/api-release)
can be browsed.
+Questions related to the usage of Apache Commons Geometry Spherical should be
posted to the [user mailing list][ml].
+
+Where can I get the latest release?
+-----------------------------------
+You can download source and binaries from our [download
page](https://commons.apache.org/proper/commons-geometry/download_geometry.cgi).
+
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-geometry-spherical</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the
main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ Create minimal diffs - disable on save actions like reformat source code or
organize imports. If you feel the source code should be reformatted create a
separate PR for this change.
++ Provide JUnit tests for your changes and make sure your changes don't break
any existing tests by running ```mvn clean test```.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
+You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
+
+License
+-------
+This code is under the [Apache Licence
v2](https://www.apache.org/licenses/LICENSE-2.0).
+
+See the `NOTICE.txt` file for required notices and attributions.
+
+Donations
+---------
+You like Apache Commons Geometry Spherical? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
+
+Additional Resources
+--------------------
+
++ [Apache Commons Homepage](https://commons.apache.org/)
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/GEOMETRY)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
diff --git a/pom.xml b/pom.xml
index 2f6a248..2ccb3c4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -30,7 +30,7 @@
<name>Apache Commons Geometry</name>
<inceptionYear>2016</inceptionYear>
- <description>The Apache Commons Geometry project provides pure-Java
implementation of pseudo-random generators.</description>
+ <description>The Apache Commons Geometry project provides geometric types
and utilities.</description>
<url>http://commons.apache.org/proper/commons-geometry/</url>
<issueManagement>
--
To stop receiving notification emails like this one, please contact
er...@apache.org.
