/example-java

Primary LanguageKotlinMIT LicenseMIT

Example project

license standard-readme compliant javadocs

This is a personal example project meant to make it easier to create other projects.

WARNING: This is only set up for single-module projects.

Table of Contents

Install

To install, simply add the library via JitPack:

Details for how to add this library with other build tools (such as Maven) can be found on the page linked above.

repositories {
    ...
    maven { url 'https://jitpack.io' }
}

dependencies {
    ...
    implementation 'com.github.GoldenStack:example-java:-SNAPSHOT'
}

Usage

This is meant for personal use, so it's not intended for anyone else to work with it.

However, to set it up, all you really need to do is copy the files, change this README to be accurate, and add it to cla-assistant.

Contributing

Feel free to open a PR or an issue.

Before starting large PRs, make sure to check that it's actually needed; try asking a maintainer.

Before a PR is merged, all contributors must sign the DCO. We use cla-assistant to verify this.

License

MIT © GoldenStack