Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.36 KB

zodiac.md

File metadata and controls

45 lines (26 loc) · 2.36 KB
Raw

Zodiac - creating documentation screenshots for Substance and Flamingo

Overview

Zodiac has a collection of classes for taking screenshots of Substance and Flamingo for documentation purposes.

Dependencies

Zodiac depends on:

Building

Run the following commands to build and collect all Zodiac runtime components:

  • ./gradlew
  • ./gradlew copyJars
  • ./gradlew getToolsDependencies

At this point, the main Zodiac jar will be in drop/VERSION/tools. Substance, Flamingo and their Radiance dependencies (Neon and Trident) will be in drop/VERSION/core. Third-party dependencies will be in build/libs-tools.

Running Zodiac scripts

Zodiac scripts are in scripts/zodiac folder. The structure of each script is:

  • Set up the version of Java to use
  • Set up the classpath with all runtime dependencies
  • Run Zodiac command for each skin / color scheme / watermark

For example, to run Zodiac to create screenshots for the Autumn skin:

export JAVA_HOME=`/usr/libexec/java_home -v 9`

alias JAVA="java"

RADIANCE_VERSION=3.0.0

KOTLIN_VERSION=1.3.50

KOTLIN_COROUTINES_VERSION=1.3.2

CLASSPATH=../../drop/$RADIANCE_VERSION/tools/radiance-zodiac-$RADIANCE_VERSION.jar:../../drop/$RADIANCE_VERSION/tools/radiance-tools-common-$RADIANCE_VERSION.jar:../../drop/$RADIANCE_VERSION/core/radiance-substance-$RADIANCE_VERSION.jar:../../drop/$RADIANCE_VERSION/core/radiance-substance-extras-$RADIANCE_VERSION.jar:../../drop/$RADIANCE_VERSION/core/radiance-neon-$RADIANCE_VERSION.jar:../../drop/$RADIANCE_VERSION/core/radiance-trident-$RADIANCE_VERSION.jar:../../drop/$RADIANCE_VERSION/demo/radiance-substance-demo-$RADIANCE_VERSION.jar:../../drop/$RADIANCE_VERSION/core/radiance-substance-extras-$RADIANCE_VERSION.jar:../../build/libs-tools/jgoodies-forms-1.9.0.jar:../../build/libs-tools/jgoodies-common-1.8.1.jar:../../build/libs-tools/kotlin-stdlib-$KOTLIN_VERSION.jar:../../build/libs-tools/kotlin-stdlib-common-$KOTLIN_VERSION.jar:../../build/libs-tools/kotlinx-coroutines-core-$KOTLIN_COROUTINES_VERSION.jar:../../build/libs-tools/kotlinx-coroutines-swing-$KOTLIN_COROUTINES_VERSION.jar

JAVA -cp $CLASSPATH org.pushingpixels.tools.zodiac.RobotMain org.pushingpixels.tools.zodiac.substance.skins.Autumn ../../docs/images/