Siphalor/tweed5-commons-logging
1
0
Fork 0
Code Activity

update README.md

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/logging/trunk@1804810 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Pascal Schumacher
2017-08-11 15:41:06 +00:00
parent da4b7ddbef
commit ae02acf389
1 changed files with 103 additions and 101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
README.md
View File

@@ -1,101 +1,103 @@
<!--- <!---
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0 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 not use this file except in compliance with
the License. You may obtain a copy of the License at the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
--> -->
<!--- <!---
+======================================================================+ +======================================================================+
|**** ****| |**** ****|
|**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
|**** DO NOT EDIT DIRECTLY ****| |**** DO NOT EDIT DIRECTLY ****|
|**** ****| |**** ****|
+======================================================================+ +======================================================================+
| TEMPLATE FILE: readme-md-template.md | | TEMPLATE FILE: readme-md-template.md |
| commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+======================================================================+ +======================================================================+
| | | |
| 1) Re-generate using: mvn commons:readme-md | | 1) Re-generate using: mvn commons:readme-md |
| | | |
| 2) Set the following properties in the component's pom: | | 2) Set the following properties in the component's pom: |
| - commons.componentid (required, alphabetic, lower case) | | - commons.componentid (required, alphabetic, lower case) |
| - commons.release.version (required) | | - commons.release.version (required) |
| | | |
| 3) Example Properties | | 3) Example Properties |
| | | |
| <properties> | | <properties> |
| <commons.componentid>math</commons.componentid> | | <commons.componentid>math</commons.componentid> |
| <commons.release.version>1.2</commons.release.version> | | <commons.release.version>1.2</commons.release.version> |
| </properties> | | </properties> |
| | | |
+======================================================================+ +======================================================================+
---> --->
Apache Commons Logging Apache Commons Logging
=================== ===================
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/badge.svg)](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/) [![Build Status](https://travis-ci.org/apache/commons-logging.svg?branch=trunk)](https://travis-ci.org/apache/commons-logging)
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/badge.svg)](https://maven-badges.herokuapp.com/maven-central/commons-logging/commons-logging/)
Apache Commons Logging is a thin adapter allowing configurable bridging to other, well known logging systems. Apache Commons Logging is a thin adapter allowing configurable bridging to other, well known logging systems.
Documentation Documentation
------------- -------------
More information can be found on the [homepage](https://commons.apache.org/proper/commons-logging). More information can be found on the [Apache Commons Logging homepage](https://commons.apache.org/proper/commons-logging).
The [JavaDoc](https://commons.apache.org/proper/commons-logging/javadocs/api-release) can be browsed. The [JavaDoc](https://commons.apache.org/proper/commons-logging/javadocs/api-release) can be browsed.
Questions related to the usage of Apache Commons Logging should be posted to the [user mailing list][ml]. Questions related to the usage of Apache Commons Logging should be posted to the [user mailing list][ml].
Where can I get the latest release? Where can I get the latest release?
----------------------------------- -----------------------------------
You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-logging/download_logging.cgi). You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-logging/download_logging.cgi).
Alternatively you can pull it from the central Maven repositories: Alternatively you can pull it from the central Maven repositories:
```xml ```xml
<dependency> <dependency>
<groupId>commons-logging</groupId> <groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId> <artifactId>commons-logging</artifactId>
<version>1.2</version> <version>1.2</version>
</dependency> </dependency>
``` ```
Contributing Contributing
------------ ------------
We accept PRs via github. The [developer mailing list][ml] is the main channel of communication for contributors. We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us: There are some guidelines which will make applying PRs easier for us:
+ No tabs! Please use spaces for indentation. + No tabs! Please use spaces for indentation.
+ Respect the code style. + 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. + 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```. + 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). 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 License
------- -------
Code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0.txt). This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).
Donations See the `NOTICE.txt` file for required notices and attributions.
---------
You like Apache Commons Logging? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. Donations
---------
Additional Resources You like Apache Commons Logging? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.
--------------------
Additional Resources
+ [Apache Commons Homepage](https://commons.apache.org/) --------------------
+ [Apache Bugtracker (JIRA)](https://issues.apache.org/jira/)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) + [Apache Commons Homepage](https://commons.apache.org/)
+ #apachecommons IRC channel on freenode.org + [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/LOGGING)
+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
[ml]:https://commons.apache.org/mail-lists.html + `#apache-commons` IRC channel on `irc.freenode.org`
[ml]:https://commons.apache.org/mail-lists.html