A basic Maven project created from the Basic Maven Archetype.
This should be set up correctly before use. Remember to verify, and change if needed, at least the following data:
- Links on the readme, POM and Maven site (repositories, issues, etc)
- Project info on the POM.
- License, if not using the MIT one (POM, readme and LICENSE file)
- This readme description
- This documentation on the Maven site
Documentation is always generated for the latest release:
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
The site sources come along the source code, so it is always possible to generate them using the Maven site command:
$ mvn site
The application is coded in Java, using Maven to handle the project's configuration and tests.
The project has been tested on the following Java versions:
- JDK 7
- 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 up the dependencies manager. To get the configuration information for this check the Bintray repository, or the Maven Central Repository.
If for some reason manual installation is necesary, just use the following Maven command:
mvn install
The project is still under ongoing development, and any help will be well received.
There are two ways to 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 page.
Everybody is allowed to report bugs or ask for features.
The latest version of the code can be found at the GitHub project page.
Feel free to fork it, and share the changes.
The project is released under the MIT License.