[prev in list] [next in list] [prev in thread] [next in thread]
List: jakarta-commons-dev
Subject: [commons-signing] 05/05: Add generated README
From: markt () apache ! org
Date: 2018-04-30 20:30:25
Message-ID: 20180430203020.B1B4A809D9 () gitbox ! apache ! org
[Download RAW message or body]
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-signing.git
commit 4c485ffa448464e65b7794895182d0c524c034cd
Author: Mark Thomas <markt@apache.org>
AuthorDate: Mon Apr 30 21:29:38 2018 +0100
Add generated README
---
README.md | 105 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 105 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f6639d6
--- /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 Signing
+===================
+
+[](https://travis-ci.org/apache/commons-signing)
+[](https://coveralls.io/r/apache/commons-signing)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-signing/)
+[](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+The Apache Commons Code Signing Library.
+
+Documentation
+-------------
+
+More information can be found on the [Apache Commons Signing \
homepage](https://commons.apache.org/proper/commons-signing). +The \
[JavaDoc](https://commons.apache.org/proper/commons-signing/javadocs/api-release) can \
be browsed. +Questions related to the usage of Apache Commons Signing 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-signing/download_signing.cgi). +
+Alternatively you can pull it from the central Maven repositories:
+
+```xml
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-signing</artifactId>
+ <version>0.0.1</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 Signing? 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/SIGNING)
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
++ `#apache-commons` IRC channel on `irc.freenode.org`
+
+[ml]:https://commons.apache.org/mail-lists.html
--
To stop receiving notification emails like this one, please contact
markt@apache.org.
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic