README.md

Runsheet Generator 🚍

Generates a Radford Transit runsheet, in the XSLS file format, from a CSV file exported by WhenToWork scheduling software.

Required software

• Java 15 SDK
• Gradle 6.6.1

Build

If you have Gradle installed, run gradle build. To wrap the build into a Windows executable, run gradle createExe

Otherwise,

• On Linux or macOS, in the project's root directory, run ./gradlew build
• On Windows, in the project's root directory, run gradlew.bat build. To wrap the build into a Windows executable, run gradlew.bat createExe.

Run

If you have Gradle installed, run gradle run

Otherwise,

• On Linux or macOS, in the project's root directory, run ./gradlew run
• On Windows, in the project's root directory, run gradlew.bat run

Style requirement

Runsheet Generator's source code complies with Google's Java Style standard.

If you have Gradle installed, to easily format the source code, run gradle spotlessApply. To verify that all *.java files are formatted properly, run gradle spotlessJavaCheck.

Otherwise,

• On Linux or macOS, in the project's root directory, run ./gradlew goJF. To verify that all *.java files are formatted properly, run ./gradlew spotlessJavaCheck.
• On Windows, in the project's root directory, run gradlew.bat goJF. To verify that all *.java files are formatted properly, run gradlew.bat spotlessJavaCheck.

Generate Javadoc

If you have Gradle installed, run gradle makeJavadocs

Otherwise,

• On Linux or macOS, in the project's root directory, run ./gradlew makeJavadocs
• On Windows, in the project's root directory, run gradlew.bat makeJavadocs

Dependencies

Automatically downloaded with Gradle

• ZB Utils 1.1
• Swing Extensions 1.0
• Apache Commons CSV 1.8
• Apache POI 4.1.2

Gradle plugins (automatically downloaded) and dependencies

• JitPack adds the ability to use Git repos as dependencies.
• Shadow combines dependency classes and resources with a project’s into a single output JAR.
• gradle-launch4j uses Launch4J to wrap JARs into Windows executables.
• Spotless plugin for Gradle uses google-java-format to reformat Java source code to comply with Google Java Style.