README.md
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--->
43Apache Commons IO
44===================
45
46[](https://github.com/apache/commons-io/actions)
47[](https://app.codecov.io/gh/apache/commons-io)
48[](https://maven-badges.herokuapp.com/maven-central/commons-io/commons-io/?gav=true)
49[](https://javadoc.io/doc/commons-io/commons-io/2.15.0)
50[](https://github.com/apache/commons-io/actions/workflows/codeql-analysis.yml?query=workflow%3ACodeQL)
51[](https://api.securityscorecards.dev/projects/github.com/apache/commons-io)
52
53The Apache Commons IO library contains utility classes, stream implementations, file filters,
54file comparators, endian transformation classes, and much more.
55
56Documentation
57-------------
58
59More information can be found on the [Apache Commons IO homepage](https://commons.apache.org/proper/commons-io).
60The [Javadoc](https://commons.apache.org/proper/commons-io/apidocs) can be browsed.
61Questions related to the usage of Apache Commons IO should be posted to the [user mailing list][ml].
62
63Getting the latest release
64--------------------------
65You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-io/download_io.cgi).
66
67Alternatively, you can pull it from the central Maven repositories:
68
69```xml
70<dependency>
71 <groupId>commons-io</groupId>
72 <artifactId>commons-io</artifactId>
73 <version>2.15.0</version>
74</dependency>
75```
76
77Building
78--------
79
80Building requires a Java JDK and [Apache Maven](https://maven.apache.org/).
81The required Java version is found in the `pom.xml` as the `maven.compiler.source` property.
82
83From a command shell, run `mvn` without arguments to invoke the default Maven goal to run all tests and checks.
84
85Contributing
86------------
87
88We accept Pull Requests via GitHub. The [developer mailing list](https://commons.apache.org/mail-lists.html) is the main channel of communication for contributors.
89There are some guidelines which will make applying PRs easier for us:
90+ No tabs! Please use spaces for indentation.
91+ Respect the existing code style for each file.
92+ 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.
93+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```.
94
95If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).
96You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).
97
98License
99-------
100This code is licensed under the [Apache License v2](https://www.apache.org/licenses/LICENSE-2.0).
101
102See the `NOTICE.txt` file for required notices and attributions.
103
104Donating
105--------
106You like Apache Commons IO? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support development.
107
108Additional Resources
109--------------------
110
111+ [Apache Commons Homepage](https://commons.apache.org/)
112+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/IO)
113+ [Apache Commons Slack Channel](https://the-asf.slack.com/archives/C60NVB8AD)
114+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)
115+ `#apache-commons` IRC channel on `irc.freenode.org`
116
117Apache Commons Components
118-------------------------
119
120Please see the [list of components](https://commons.apache.org/components.html)
121
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}