This repository has been archived by the owner on Mar 15, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
15 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,33 @@ | ||
# About | ||
[![License BSD 3-Clause](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg)](http://directory-content-maven-plugin.projects.gabrys.biz/license.txt) | ||
[![Build Status](https://travis-ci.org/gabrysbiz/directory-content-maven-plugin.svg?branch=develop)](https://travis-ci.org/gabrysbiz/directory-content-maven-plugin) | ||
[![Build Status](https://travis-ci.org/gabrysbiz/directory-content-maven-plugin.svg?branch=release%2F1.2.1)](https://travis-ci.org/gabrysbiz/directory-content-maven-plugin) | ||
|
||
Provides a collection of tools for working with directories. | ||
|
||
# Goals Overview | ||
* [directory-content:copy](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/copy-mojo.html) - copies files to directory | ||
* [directory-content:copyFile](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/copyFile-mojo.html) - copies file from source to output directory (allow to change name) | ||
* [directory-content:transformList](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/transformList-mojo.html) - transforms files list to a document using [XSLT](http://www.w3.org/TR/xslt) technology | ||
* [directory-content:transformMetadata](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/transformMetadata-mojo.html) - transforms files metadata to documents using [XSLT](http://www.w3.org/TR/xslt) technology | ||
* [directory-content:copy](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/copy-mojo.html) - copies files to directory | ||
* [directory-content:copyFile](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/copyFile-mojo.html) - copies file from source to output directory (allow to change name) | ||
* [directory-content:transformList](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/transformList-mojo.html) - transforms files list to a document using [XSLT](http://www.w3.org/TR/xslt) technology | ||
* [directory-content:transformMetadata](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/transformMetadata-mojo.html) - transforms files metadata to documents using [XSLT](http://www.w3.org/TR/xslt) technology | ||
|
||
# Requirements | ||
The plugin to run requires: | ||
* Java 5.0 or higher | ||
* Maven 2.0.11 or higher | ||
|
||
# Usage | ||
General instructions on how to use the Directory Content Maven Plugin can be found on the [usage](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/usage.html) page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's [wiki](https://github.com/gabrysbiz/directory-content-maven-plugin/wiki) page. | ||
General instructions on how to use the Directory Content Maven Plugin can be found on the [usage](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/usage.html) page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's [wiki](https://github.com/gabrysbiz/directory-content-maven-plugin/wiki) page. | ||
|
||
In case you still have questions regarding the plugin's usage, please have a look at the [FAQ](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/faq.html). | ||
In case you still have questions regarding the plugin's usage, please have a look at the [FAQ](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/faq.html). | ||
|
||
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in the [issue tracker](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/issue-tracking.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from the [source repository](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/source-repository.html) and will find supplementary information in the [guide to helping with Maven](http://maven.apache.org/guides/development/guide-helping.html). | ||
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in the [issue tracker](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/issue-tracking.html). When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from the [source repository](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/source-repository.html) and will find supplementary information in the [guide to helping with Maven](http://maven.apache.org/guides/development/guide-helping.html). | ||
|
||
# Examples | ||
To provide you with better understanding of some usages of the Directory Content Maven Plugin, you can take a look into the following examples: | ||
* [Using include/exclude patterns](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/examples/patterns.html) | ||
* [Copies files from source to output directory](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/examples/copy.html) | ||
* [Copies file to output directory with a new name](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/examples/copyFile.html) | ||
* [Transform files list to file with JavaScript imports](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/examples/transform-list.html) | ||
* [Transform files metadata to download files](http://directory-content-maven-plugin.projects.gabrys.biz/LATEST/examples/transform-metadata.html) | ||
* [Using include/exclude patterns](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/examples/patterns.html) | ||
* [Copies files from source to output directory](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/examples/copy.html) | ||
* [Copies file to output directory with a new name](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/examples/copyFile.html) | ||
* [Transform files list to file with JavaScript imports](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/examples/transform-list.html) | ||
* [Transform files metadata to download files](http://directory-content-maven-plugin.projects.gabrys.biz/1.2.1/examples/transform-metadata.html) | ||
|
||
You can also fetch example projects from [GitHub](https://github.com/gabrysbiz/directory-content-maven-plugin-examples). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters