Ikonli

---

Ikonli provides icon packs that can be used in Java applications. Currently Swing and JavaFX UI toolkits are supported.

Installing

You can get the latest version of Ikonli directly from Maven Central.

Refer to the guide for further information on configuration and usage.

Building

You must meet the following requirements:

• JDK11 as a minimum

• Gradle 6.4+

You may use the included gradle wrapper script if you don’t have gradle installed.

Adapt these instructions to Windows settings if running on Windows.

Installing Gradle

Manual

1. Download Gradle from http://gradle.org/downloads

2. Unzip the file into a directory without spaces (recommended).

3. Create a GRADLE_HOME environment variable that points to this directory.

4. Adjust your PATH environment variable to include $GRADLE_HOME/bin (%GRADLE_HOME%\bin on Windows).

5. Test your setup by invoking gradle --version.

SDKMAN

1. Follow the instructions found at http://sdkman.io/ to install SDKMAN.

2. You need a POSIX environment if running Windows. We recommend using Babun Shell (http://babun.github.io/)

3. Once SDKMAN is installed invoke sdk install gradle 6.9.2.

4. Test your setup by invoking gradle --version.

Gum

Gum is a wrapper script that facilitates invoking gradle tasks anywhere within a Gradle project. It’s smart enough to use the gradle wrapper if available or your global gradle command. This is an optional download.

1. Follow the instructions found at https://github.com/kordamp/gm to install gum

Next Steps

Make a full build issuing gm build.

Run the sampler JavaFX application by invoking the following command

$ gm :sampler-javafx:run

Run the sampler Swing application by invoking the following command

$ gm :sampler-swing:run

Run the Ikonli Browser application by invoking the following command

$ gm :ikonli-browser:run

Publishing your own SNAPSHOT

You can publish a local snapshot release by issuing this command

$ gm install

If you don’t Gum installed then issue this command

$ ./gradlew publishToMavenLocal