|
1 | | -<!--- |
2 | | - Licensed to the Apache Software Foundation (ASF) under one or more |
3 | | - contributor license agreements. See the NOTICE file distributed with |
4 | | - this work for additional information regarding copyright ownership. |
5 | | - The ASF licenses this file to You under the Apache License, Version 2.0 |
6 | | - (the "License"); you may not use this file except in compliance with |
7 | | - the License. You may obtain a copy of the License at |
8 | | -
|
9 | | - http://www.apache.org/licenses/LICENSE-2.0 |
10 | | -
|
11 | | - Unless required by applicable law or agreed to in writing, software |
12 | | - distributed under the License is distributed on an "AS IS" BASIS, |
13 | | - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
14 | | - See the License for the specific language governing permissions and |
15 | | - limitations under the License. |
16 | | ---> |
17 | | -<!--- |
18 | | - +======================================================================+ |
19 | | - |**** ****| |
20 | | - |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| |
21 | | - |**** DO NOT EDIT DIRECTLY ****| |
22 | | - |**** ****| |
23 | | - +======================================================================+ |
24 | | - | TEMPLATE FILE: readme-md-template.md | |
25 | | - | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | |
26 | | - +======================================================================+ |
27 | | - | | |
28 | | - | 1) Re-generate using: mvn commons-build:readme-md | |
29 | | - | | |
30 | | - | 2) Set the following properties in the component's pom: | |
31 | | - | - commons.componentid (required, alphabetic, lower case) | |
32 | | - | - commons.release.version (required) | |
33 | | - | | |
34 | | - | 3) Example Properties | |
35 | | - | | |
36 | | - | <properties> | |
37 | | - | <commons.componentid>math</commons.componentid> | |
38 | | - | <commons.release.version>1.2</commons.release.version> | |
39 | | - | </properties> | |
40 | | - | | |
41 | | - +======================================================================+ |
42 | | ----> |
43 | | -Apache Commons CLI |
44 | | -=================== |
45 | | - |
46 | | -[](https://github.com/apache/commons-cli/actions) |
47 | | -[](https://coveralls.io/r/apache/commons-cli) |
48 | | -[](https://maven-badges.herokuapp.com/maven-central/commons-cli/commons-cli/) |
49 | | -[](https://javadoc.io/doc/commons-cli/commons-cli/1.5.0) |
50 | | -[](https://github.com/apache/commons-cli/actions?query=workflow%3ACodeQL) |
51 | | - |
52 | | -Apache Commons CLI provides a simple API for presenting, processing and validating a Command Line Interface. |
53 | | - |
54 | | -Documentation |
55 | | -------------- |
56 | | - |
57 | | -More information can be found on the [Apache Commons CLI homepage](https://commons.apache.org/proper/commons-cli). |
58 | | -The [Javadoc](https://commons.apache.org/proper/commons-cli/apidocs) can be browsed. |
59 | | -Questions related to the usage of Apache Commons CLI should be posted to the [user mailing list][ml]. |
60 | | - |
61 | | -Where can I get the latest release? |
62 | | ------------------------------------ |
63 | | -You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-cli/download_cli.cgi). |
64 | | - |
65 | | -Alternatively you can pull it from the central Maven repositories: |
66 | | - |
67 | | -```xml |
68 | | -<dependency> |
69 | | - <groupId>commons-cli</groupId> |
70 | | - <artifactId>commons-cli</artifactId> |
71 | | - <version>1.5.0</version> |
72 | | -</dependency> |
73 | | -``` |
74 | | - |
75 | | -Contributing |
76 | | ------------- |
77 | | - |
78 | | -We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. |
79 | | -There are some guidelines which will make applying PRs easier for us: |
80 | | -+ No tabs! Please use spaces for indentation. |
81 | | -+ Respect the code style. |
82 | | -+ 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. |
83 | | -+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```. |
84 | | - |
85 | | -If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). |
86 | | -You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). |
87 | | - |
88 | | -License |
89 | | -------- |
90 | | -This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). |
91 | | - |
92 | | -See the `NOTICE.txt` file for required notices and attributions. |
93 | | - |
94 | | -Donations |
95 | | ---------- |
96 | | -You like Apache Commons CLI? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. |
97 | | - |
98 | | -Additional Resources |
99 | | --------------------- |
100 | | - |
101 | | -+ [Apache Commons Homepage](https://commons.apache.org/) |
102 | | -+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CLI) |
103 | | -+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) |
104 | | -+ `#apache-commons` IRC channel on `irc.freenode.org` |
105 | | - |
106 | | -[ml]:https://commons.apache.org/mail-lists.html |
| 1 | +<!--- |
| 2 | + Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + contributor license agreements. See the NOTICE file distributed with |
| 4 | + this work for additional information regarding copyright ownership. |
| 5 | + The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + (the "License"); you may not use this file except in compliance with |
| 7 | + the License. You may obtain a copy of the License at |
| 8 | +
|
| 9 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +
|
| 11 | + Unless required by applicable law or agreed to in writing, software |
| 12 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + See the License for the specific language governing permissions and |
| 15 | + limitations under the License. |
| 16 | +--> |
| 17 | +<!--- |
| 18 | + +======================================================================+ |
| 19 | + |**** ****| |
| 20 | + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| |
| 21 | + |**** DO NOT EDIT DIRECTLY ****| |
| 22 | + |**** ****| |
| 23 | + +======================================================================+ |
| 24 | + | TEMPLATE FILE: readme-md-template.md | |
| 25 | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | |
| 26 | + +======================================================================+ |
| 27 | + | | |
| 28 | + | 1) Re-generate using: mvn commons-build:readme-md | |
| 29 | + | | |
| 30 | + | 2) Set the following properties in the component's pom: | |
| 31 | + | - commons.componentid (required, alphabetic, lower case) | |
| 32 | + | - commons.release.version (required) | |
| 33 | + | | |
| 34 | + | 3) Example Properties | |
| 35 | + | | |
| 36 | + | <properties> | |
| 37 | + | <commons.componentid>math</commons.componentid> | |
| 38 | + | <commons.release.version>1.2</commons.release.version> | |
| 39 | + | </properties> | |
| 40 | + | | |
| 41 | + +======================================================================+ |
| 42 | +---> |
| 43 | +Apache Commons CLI |
| 44 | +=================== |
| 45 | + |
| 46 | +[](https://github.com/apache/commons-cli/actions) |
| 47 | +[](https://coveralls.io/r/apache/commons-cli) |
| 48 | +[](https://maven-badges.herokuapp.com/maven-central/commons-cli/commons-cli/) |
| 49 | +[](https://javadoc.io/doc/commons-cli/commons-cli/1.5.0) |
| 50 | +[](https://github.com/apache/commons-cli/actions?query=workflow%3ACodeQL) |
| 51 | + |
| 52 | +Apache Commons CLI provides a simple API for presenting, processing and validating a Command Line Interface. |
| 53 | + |
| 54 | +Documentation |
| 55 | +------------- |
| 56 | + |
| 57 | +More information can be found on the [Apache Commons CLI homepage](https://commons.apache.org/proper/commons-cli). |
| 58 | +The [Javadoc](https://commons.apache.org/proper/commons-cli/apidocs) can be browsed. |
| 59 | +Questions related to the usage of Apache Commons CLI should be posted to the [user mailing list][ml]. |
| 60 | + |
| 61 | +Where can I get the latest release? |
| 62 | +----------------------------------- |
| 63 | +You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-cli/download_cli.cgi). |
| 64 | + |
| 65 | +Alternatively you can pull it from the central Maven repositories: |
| 66 | + |
| 67 | +```xml |
| 68 | +<dependency> |
| 69 | + <groupId>commons-cli</groupId> |
| 70 | + <artifactId>commons-cli</artifactId> |
| 71 | + <version>1.5.0</version> |
| 72 | +</dependency> |
| 73 | +``` |
| 74 | + |
| 75 | +Contributing |
| 76 | +------------ |
| 77 | + |
| 78 | +We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. |
| 79 | +There are some guidelines which will make applying PRs easier for us: |
| 80 | ++ No tabs! Please use spaces for indentation. |
| 81 | ++ Respect the code style. |
| 82 | ++ 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. |
| 83 | ++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```. |
| 84 | + |
| 85 | +If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). |
| 86 | +You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). |
| 87 | + |
| 88 | +License |
| 89 | +------- |
| 90 | +This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). |
| 91 | + |
| 92 | +See the `NOTICE.txt` file for required notices and attributions. |
| 93 | + |
| 94 | +Donations |
| 95 | +--------- |
| 96 | +You like Apache Commons CLI? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. |
| 97 | + |
| 98 | +Additional Resources |
| 99 | +-------------------- |
| 100 | + |
| 101 | ++ [Apache Commons Homepage](https://commons.apache.org/) |
| 102 | ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/CLI) |
| 103 | ++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) |
| 104 | ++ `#apache-commons` IRC channel on `irc.freenode.org` |
| 105 | + |
| 106 | +[ml]:https://commons.apache.org/mail-lists.html |
0 commit comments