Welcome to the JUtilities!

This repository contains the Java utility library of mhahnFr.

Usage

Use this library by integrating it as a dependency of your project.

To do so, you can:

Download it from GitHub Packages.
Download a release.
Build it yourself.

GitHub Packages

To use the JUtilities as dependency from GitHub Packages, follow the instructions here.

It can be used as dependency in your Gradle build script as follows:

repositories {
    maven {
        url = uri('https://maven.pkg.github.com/mhahnfr/jutilities')
        credentials {
            username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
            password = project.findProperty("gpr.token") ?: System.getenv("TOKEN")
        }
    }
}

dependencies {
    implementation 'mhahnfr:jutilities:0.1.1'
}

Release

The releases can also be used as dependency in your Gradle build script:

repositories {
    ivy {
        url 'https://github.com/'
        patternLayout {
            artifact '/[organisation]/[module]/releases/download/v[revision]/[module]-[revision].jar'
        }
        metadataSources { artifact() }
    }
}

dependencies {
    implementation 'mhahnfr:jutilities:0.1.1'
}

Building from source

To build a jar file that can be included in other projects, simply run ./gradlew jar.

Git Submodule

You can add this repository as a git submodule to your project.

To use the JUtilities as submodule you can add the following to your build.gradle:

dependencies {
    implementation project(':JUtilities')
}

and add it in your settings.gradle:

include('JUtilities')

Final notes

This library requires Java in version 19 or higher.

This library is licensed under the terms of the GNU GPL 3.0.