This is an automated email from the ASF dual-hosted git repository. mattjuntunen pushed a commit to branch 1.0-beta1-release in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
commit 8d34e7680e075423dec467c92bf07f9c0a741c08 Author: Matt Juntunen <mattjuntu...@apache.org> AuthorDate: Sat Jul 4 11:50:03 2020 -0400 updating READMEs; bumping rc number --- README.md | 23 +-- commons-geometry-core/README.md | 210 ++++++++++----------- commons-geometry-enclosing/README.md | 210 ++++++++++----------- commons-geometry-euclidean/README.md | 210 ++++++++++----------- commons-geometry-examples/README.md | 10 +- commons-geometry-examples/examples-io/README.md | 16 +- commons-geometry-examples/examples-jmh/README.md | 6 +- .../examples-tutorials/README.md | 8 +- commons-geometry-hull/README.md | 210 ++++++++++----------- commons-geometry-spherical/README.md | 210 ++++++++++----------- pom.xml | 2 +- 11 files changed, 554 insertions(+), 561 deletions(-) diff --git a/README.md b/README.md index c383656..1c0fe2c 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,17 +43,10 @@ Apache Commons Geometry =================== -[![Build Status](https://travis-ci.org/apache/commons-geometry.svg?branch=master)](https://travis-ci.org/apache/commons-geometry) -[![Coverage Status](https://coveralls.io/repos/github/apache/commons-geometry/badge.svg?branch=master)](https://coveralls.io/github/apache/commons-geometry?branch=master) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=commons-geometry&metric=alert_status)](https://sonarcloud.io/dashboard?id=commons-geometry) -<!--- -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/) ----> -[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) +[![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) +[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-parent/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-parent/) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-parent/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-parent/1.0-beta1) The Apache Commons Geometry project provides geometric types and utilities. @@ -61,7 +54,7 @@ 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. +The [Javadoc](https://commons.apache.org/proper/commons-geometry/apidocs) 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? @@ -73,8 +66,8 @@ Alternatively you can pull it from the central Maven repositories: ```xml <dependency> <groupId>org.apache.commons</groupId> - <artifactId>commons-geometry</artifactId> - <version>1.0</version> + <artifactId>commons-geometry-parent</artifactId> + <version>1.0-beta1</version> </dependency> ``` diff --git a/commons-geometry-core/README.md b/commons-geometry-core/README.md index c9c3edf..6675fcf 100644 --- a/commons-geometry-core/README.md +++ b/commons-geometry-core/README.md @@ -1,105 +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 -=================== - -[![Build Status](https://travis-ci.org/apache/commons-geometry-core.svg?branch=master)](https://travis-ci.org/apache/commons-geometry-core) -[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry-core/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-geometry-core) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/) -[![License](http://img.shields.io/:license-apache-blue.svg)](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 +<!--- + 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-build:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +Apache Commons Geometry Core +=================== + +[![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) +[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-core/) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-core/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-core/1.0-beta1) + +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/apidocs) 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-beta1</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 index 08c174a..a34e6d0 100644 --- a/commons-geometry-enclosing/README.md +++ b/commons-geometry-enclosing/README.md @@ -1,105 +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 -=================== - -[![Build Status](https://travis-ci.org/apache/commons-geometry-enclosing.svg?branch=master)](https://travis-ci.org/apache/commons-geometry-enclosing) -[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry-enclosing/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-geometry-enclosing) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/) -[![License](http://img.shields.io/:license-apache-blue.svg)](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 +<!--- + 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-build:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +Apache Commons Geometry Enclosing +=================== + +[![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) +[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-enclosing/) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-enclosing/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-enclosing/1.0-beta1) + +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/apidocs) 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-beta1</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 index 658cd4f..50b6902 100644 --- a/commons-geometry-euclidean/README.md +++ b/commons-geometry-euclidean/README.md @@ -1,105 +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 -=================== - -[![Build Status](https://travis-ci.org/apache/commons-geometry-euclidean.svg?branch=master)](https://travis-ci.org/apache/commons-geometry-euclidean) -[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry-euclidean/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-geometry-euclidean) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/) -[![License](http://img.shields.io/:license-apache-blue.svg)](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 +<!--- + 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-build:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +Apache Commons Geometry Euclidean +=================== + +[![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) +[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-euclidean/) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-euclidean/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-euclidean/1.0-beta1) + +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/apidocs) 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-beta1</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-examples/README.md b/commons-geometry-examples/README.md index 5987929..ac79366 100644 --- a/commons-geometry-examples/README.md +++ b/commons-geometry-examples/README.md @@ -46,12 +46,12 @@ Apache Commons Geometry Examples [![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) [![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples/) -[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples/1.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples/1.0) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples/1.0-beta1) Examples of use of the "Commons Geometry" 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. + They provide code examples, checking, and benchmarking tools to enhance + the documentation and to help ensure correctness of the implementations. Documentation ------------- @@ -70,7 +70,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-geometry-examples</artifactId> - <version>1.0</version> + <version>1.0-beta1</version> </dependency> ``` @@ -85,7 +85,7 @@ There are some guidelines which will make applying PRs easier for us: + 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). +You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). License ------- diff --git a/commons-geometry-examples/examples-io/README.md b/commons-geometry-examples/examples-io/README.md index fe68153..8b246d2 100644 --- a/commons-geometry-examples/examples-io/README.md +++ b/commons-geometry-examples/examples-io/README.md @@ -40,23 +40,23 @@ | | +======================================================================+ ---> -Persistent storage examples +Apache Commons Geometry IO Examples =================== [![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) [![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples-io/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples-io/) -[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples-io/1.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples-io/1.0) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples-io/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples-io/1.0-beta1) -Contains examples for saving shapes to persistent storage. +Contains code examples for reading and writing geometric objects to persistent storage. Code in this module is not part of the public API. Documentation ------------- -More information can be found on the [Persistent storage examples homepage](https://commons.apache.org/proper/commons-geometry). +More information can be found on the [Apache Commons Geometry IO Examples homepage](https://commons.apache.org/proper/commons-geometry). The [Javadoc](https://commons.apache.org/proper/commons-geometry/apidocs) can be browsed. -Questions related to the usage of Persistent storage examples should be posted to the [user mailing list][ml]. +Questions related to the usage of Apache Commons Geometry IO Examples should be posted to the [user mailing list][ml]. Where can I get the latest release? ----------------------------------- @@ -68,7 +68,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-geometry-examples-io</artifactId> - <version>1.0</version> + <version>1.0-beta1</version> </dependency> ``` @@ -83,7 +83,7 @@ There are some guidelines which will make applying PRs easier for us: + 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). +You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). License ------- @@ -93,7 +93,7 @@ See the `NOTICE.txt` file for required notices and attributions. Donations --------- -You like Persistent storage examples? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. +You like Apache Commons Geometry IO Examples? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Additional Resources -------------------- diff --git a/commons-geometry-examples/examples-jmh/README.md b/commons-geometry-examples/examples-jmh/README.md index 87c428e..32a4fdb 100644 --- a/commons-geometry-examples/examples-jmh/README.md +++ b/commons-geometry-examples/examples-jmh/README.md @@ -46,7 +46,7 @@ Apache Commons Geometry JMH Benchmark [![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) [![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples-jmh/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples-jmh/) -[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples-jmh/1.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples-jmh/1.0) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples-jmh/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples-jmh/1.0-beta1) Code for running JMH benchmarks that assess performance. Code in this module is not part of the public API. @@ -68,7 +68,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-geometry-examples-jmh</artifactId> - <version>1.0</version> + <version>1.0-beta1</version> </dependency> ``` @@ -83,7 +83,7 @@ There are some guidelines which will make applying PRs easier for us: + 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). +You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). License ------- diff --git a/commons-geometry-examples/examples-tutorials/README.md b/commons-geometry-examples/examples-tutorials/README.md index 12f8558..b6e4098 100644 --- a/commons-geometry-examples/examples-tutorials/README.md +++ b/commons-geometry-examples/examples-tutorials/README.md @@ -46,9 +46,9 @@ Apache Commons Geometry Tutorials [![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) [![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples-tutorials/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-examples-tutorials/) -[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples-tutorials/1.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples-tutorials/1.0) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-examples-tutorials/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-examples-tutorials/1.0-beta1) -Contains code used in project tutorials. +Contains code used in project tutorials. Code in this module is not part of the public API. Documentation ------------- @@ -67,7 +67,7 @@ Alternatively you can pull it from the central Maven repositories: <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-geometry-examples-tutorials</artifactId> - <version>1.0</version> + <version>1.0-beta1</version> </dependency> ``` @@ -82,7 +82,7 @@ There are some guidelines which will make applying PRs easier for us: + 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). +You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). License ------- diff --git a/commons-geometry-hull/README.md b/commons-geometry-hull/README.md index 4daa00c..34a61bf 100644 --- a/commons-geometry-hull/README.md +++ b/commons-geometry-hull/README.md @@ -1,105 +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 -=================== - -[![Build Status](https://travis-ci.org/apache/commons-geometry-hull.svg?branch=master)](https://travis-ci.org/apache/commons-geometry-hull) -[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry-hull/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-geometry-hull) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/) -[![License](http://img.shields.io/:license-apache-blue.svg)](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 +<!--- + 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-build:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +Apache Commons Geometry Hull +=================== + +[![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) +[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-hull/) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-hull/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-hull/1.0-beta1) + +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/apidocs) 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-beta1</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 index 3543917..f155e51 100644 --- a/commons-geometry-spherical/README.md +++ b/commons-geometry-spherical/README.md @@ -1,105 +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 -=================== - -[![Build Status](https://travis-ci.org/apache/commons-geometry-spherical.svg?branch=master)](https://travis-ci.org/apache/commons-geometry-spherical) -[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry-spherical/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-geometry-spherical) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/) -[![License](http://img.shields.io/:license-apache-blue.svg)](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 +<!--- + 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-build:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +Apache Commons Geometry Spherical +=================== + +[![Build Status](https://travis-ci.org/apache/commons-geometry.svg)](https://travis-ci.org/apache/commons-geometry) +[![Coverage Status](https://coveralls.io/repos/apache/commons-geometry/badge.svg)](https://coveralls.io/r/apache/commons-geometry) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-geometry-spherical/) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-geometry-spherical/1.0-beta1.svg)](https://javadoc.io/doc/org.apache.commons/commons-geometry-spherical/1.0-beta1) + +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/apidocs) 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-beta1</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 ea763c1..dcecbac 100644 --- a/pom.xml +++ b/pom.xml @@ -44,7 +44,7 @@ <!-- do not use snapshot suffix here --> <commons.release.version>1.0-beta1</commons.release.version> <commons.release.desc>(requires Java 8+)</commons.release.desc> - <commons.rc.version>RC1</commons.rc.version> + <commons.rc.version>RC2</commons.rc.version> <commons.binary.suffix>-bin</commons.binary.suffix> <commons.jira.id>GEOMETRY</commons.jira.id>