Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 2.53 KB

README.md

File metadata and controls

61 lines (47 loc) · 2.53 KB
Raw

build release maven license

xml-objects

xml-objects is a simple and lightweight XML-to-object mapping library.

License

xml-objects is licensed under the Apache License, Version 2.0. See the LICENSE file for more details.

Latest release

The latest stable release of xml-objects is 1.1.1.

Download the latest xml-objects release binaries here. Previous releases are available from the releases section.

Contributing

  • To file bugs found in the software create a GitHub issue.
  • To contribute code for fixing filed issues create a pull request with the issue id.
  • To propose a new feature create a GitHub issue and open a discussion.

Building

xml-objects requires Java 17 or higher. The project uses Gradle as build system. To build the library from source, clone the repository to your local machine and run the following command from the root of the repository.

> gradlew installDist

The script automatically downloads all required dependencies for building the module. So make sure you are connected to the internet.

The build process creates the output files in the folder build/install/xml-objects. Simply put the xml-objects-<version>.jar library file and its mandatory dependencies from the lib folder on your modulepath to start developing with xml-objects. Have fun :-)

Maven artifact

xml-objects is also available as Maven artifact from the Maven Central Repository. To add xml-objects to your project with Maven, add the following code to your pom.xml. You may need to adapt the xml-objects version number.

<dependency>
  <groupId>org.xmlobjects</groupId>
  <artifactId>xml-objects</artifactId>
  <version>1.1.1</version>
</dependency>

Here is how you use xml-objects with your Gradle project:

repositories {
  mavenCentral()
}

dependencies {
  compile 'org.xmlobjects:xml-objects:1.1.1'
}