This important comment should be part of the API docs.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/imaging/trunk@1749370 13f79535-47bb-0310-9956-ffa450edef68
1 file changed
tree: 44edbbab73924e3b8cf2d20c7d6e35a622437565
  1. src/
  2. .gitignore
  3. .travis.yml
  4. CONTRIBUTING.md
  5. LICENSE.txt
  6. NOTICE.txt
  7. pom.xml
  8. README.md
  9. RELEASE-NOTES.txt
README.md

Apache Commons Imaging

Build Status License

Apache Commons Imaging (previously Sanselan) is a pure-Java image library.

Documentation

More information can be found on the homepage. The JavaDoc can be browsed. Questions related to the usage of Apache Commons Imaging should be posted to the user mailing list.

Where can I get the latest release?

There is currently no stable release of Imaging. However you can pull the latest SNAPSHOT from the Apache snapshot repository by adding the snapshot repository to your pom.xml:

<repository>
  <id>apache.snapshots</id>
  <name>Apache Development Snapshot Repository</name>
  <url>https://repository.apache.org/content/repositories/snapshots/</url>
  <releases>
    <enabled>false</enabled>
  </releases>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository> 

Then you can use the SNAPSHOT version of Commons Imaging in your pom.xml:

<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-imaging</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

The last stable release of Sanselan, before it was renamed to Imaging, was 0.97. You may:

  • Download source and binaries from our download page.
  • Pull it from the central Maven repositories:
<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-sanselan</artifactId>
  <version>0.97</version>
</dependency>

Note that Commons Imaging and Commons Sanselan are neither binary nor source compatible.

Contributing

We accept PRs via github. The developer mailing list 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. You can learn more about contributing via GitHub in our contribution guidelines.

License

Code is under the Apache Licence v2.

Donations

You like Apache Commons Imaging? Then donate back to the ASF to support the development.

Additional Resources