This is a basic Maven-based Java project created with the use of the Library Maven Archetype. It will ease the development of new libraries, setting it up for CI through the use of three free services: Github, Travis and Bintray.
Before beginning with the new project there are a few things which should be edited:
- This readme's description has to be adapted to the new project.
- Project info on the POM should be checked.
- The various links on the readme, POM and Maven site (for repositories, issues, etc) should be verified.
- The documentation on the project's Maven Site has to be written.
- The license, if not using the MIT one, should be changed. Remember that this is referenced on the POM, readme and LICENSE files.
Note that the Maven site is using the Docs Maven Skin, which will have a few configuration requirements of its own.
The project by default comes with a useful series of features:
- Preconfigured POM to begin developing a new library fast.
- Prepared for Travis CI, including configuration files and deployment scripts. Check the Archetype documentation to find out more.
- Unit and integration tests suites ready to be run with JUnit just by using the Maven test and verify commands.
- A Maven site, using the Docs Maven Skin, to contain the documentation, the Javadocs and several reports.
- A bunch of useful files, such as readme, gitignore and gitattributes.
Documentation is always generated for the latest release, kept in the 'master' branch:
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
The documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:
$ mvn verify site
The verify phase is required, otherwise some of the reports won't be generated.
The application is coded in Java, using Maven to manage the project.
It is a Java library, meant to be included as a dependency on any project which may want to make use of it.
The project has been tested on the following Java versions:
- JDK 8
- OpenJDK 7
All other dependencies are handled through Maven, and noted in the included POM file.
The recommended way to install the project is by setting it up as a dependency. To get the configuration information for this check the Bintray repository, or the Maven Central Repository.
It is always possible installing it by using the usual Maven command:
$ mvn install
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.
If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
The project has been released under the MIT License.