You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2020/06/12 22:19:18 UTC
[commons-graph] 03/04: added README.md
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-graph.git
commit b1edd04f099dfdbe323553e3a2573791f890d894
Author: Amey Jadiye <am...@gmail.com>
AuthorDate: Wed Jun 10 23:52:16 2020 +0530
added README.md
---
README.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 95 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb259e2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,95 @@
+<!---
+ 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 Graph (Sandbox)
+===================
+
+[](https://travis-ci.org/apache/commons-graph)
+[](https://coveralls.io/r/apache/commons-graph)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-graph/)
+[](https://javadoc.io/doc/org.apache.commons/commons-graph/1.0-beta1)
+
+The Apache Commons Graph package is a toolkit for managing graphs and graph based data structures.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Graph (Sandbox) homepage](https://commons.apache.org/sandbox/commons-graph/).
+The [Javadoc](https://commons.apache.org/sandbox/commons-graph/apidocs) can be browsed.
+Questions related to the usage of Apache Commons Graph (Sandbox) should be posted to the [user mailing list][https://commons.apache.org/mail-lists.html].
+
+Where can I get the latest release?
+-----------------------------------
+Yet to release.
+
+Contributing
+------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][https://commons.apache.org/mail-lists.html] is the main channel of communication for contributors.
+There are some guidelines which will make applying PRs easier for us:
++ No tabs! Please use spaces for indentation.
++ Respect the code style.
++ 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 Graph (Sandbox)? 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/SANDBOX-509?jql=project%20%3D%20SANDBOX%20AND%20component%20%3D%20Graph)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html