Merge pull request #401 from Bram-Hub/gradle

Gradle update
Merging

.github/workflows/publish-javadoc.yml

@@ -0,0 +1,21 @@
+# modified from https://github.com/MathieuSoysal/Javadoc-publisher.yml
+
+name: Publish Javadoc
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Publish JavaDoc
+        uses: MathieuSoysal/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          javadoc-branch: javadoc
+          java-version: 8
+          target-folder: docs
+          project: gradle

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="https://user-images.githubusercontent.com/46334090/180582690-a65937c6-6766-40f7-a21e-c1d8bbb3b26a.png"></a>
+    <img src="https://user-images.githubusercontent.com/46334090/180582690-a65937c6-6766-40f7-a21e-c1d8bbb3b26a.png">
     <br />
     <br />
     <a href="https://choosealicense.com/licenses/gpl-3.0/"><img src="https://img.shields.io/badge/license-GPL%203.0-red" alt="GPL 3.0 License"></a>
@@ -47,6 +47,8 @@ Additionally, if you are interested in computer science and programming, please
 ## Documentation
 Documentation is actively being worked on on the [Legup wiki](https://github.com/Bram-Hub/Legup/wiki). 
 
+The Javadocs for our application are currently hosted directly on [our Github Pages site](https://bram-hub.github.io/Legup/).
+
 Documentation is very much in the early stages, and we would greatly appreciate anyone who is willing to help write and structure the documentation. Currently, the priority is to write detailed documentation on how Nurikabe works, as it is the puzzle that is the most developed within Legup.
 
 ## Contributing

build.gradle.kts

@@ -0,0 +1,90 @@
+plugins {
+    `java-library`
+    checkstyle
+    id("edu.sc.seis.launch4j") version("2.5.3")
+    id("com.github.johnrengelman.shadow") version "4.0.4"
+}
+repositories {
+    mavenCentral()
+}
+
+
+/* Maven artifact coordinates */
+group = "edu.rpi.Legup"
+version = "2.0.0"
+val artifactId = "Legup"
+
+/* important / reused build properties */
+object BuildProps {
+    const val mainClassName = "edu.rpi.legup.Legup"
+    const val splashImagePath = "edu/rpi/legup/images/Legup/LegupSplash.png"
+    val minJavaVersion = JavaVersion.VERSION_1_8
+    const val minJavaVersionString = "1.8.0"
+}
+
+
+java {
+    sourceCompatibility = BuildProps.minJavaVersion
+    targetCompatibility = BuildProps.minJavaVersion
+}
+
+dependencies {
+    implementation("org.jetbrains:annotations:23.0.0")
+    implementation("org.apache.httpcomponents:httpclient:4.5.13")
+    api("org.slf4j:slf4j-api:2.0.4")
+    api("org.slf4j:slf4j-simple:2.0.4")
+    api("org.apache.logging.log4j:log4j-api:2.19.0")
+    api("org.apache.logging.log4j:log4j-core:2.19.0")
+    api("org.apache.commons:commons-lang3:3.12.0")
+    testImplementation("junit:junit:4.13.2")
+}
+
+tasks {
+    jar {
+        manifest {
+            attributes(
+                "Implementation-Title" to artifactId,
+                "Implementation-Version" to project.version,
+                "Main-Class" to BuildProps.mainClassName,
+                "SplashScreen-Image" to BuildProps.splashImagePath
+            )
+        }
+    }
+
+    javadoc {
+        // prevent javadoc task failure from semantic errors in Javadoc -- errors will still be logged
+        isFailOnError = false
+    }
+
+    /*
+     * CREATES NATIVE WINDOWS EXECUTABLE
+     * Launches launch4j to create an executable (.exe) file wrapping the jar
+     * THIS IS NOT THE INSTALLER
+     * Add "icon = "path/to/icon.ico"" to set an icon for the executable
+     */
+    createExe {
+        mainClassName = BuildProps.mainClassName
+        outputDir = "../native/windows"
+        outfile = "bin/Legup.exe"
+        bundledJrePath = "jre"
+        bundledJre64Bit = true
+        jdkPreference = "preferJre"
+        jreMinVersion = BuildProps.minJavaVersionString
+        jreRuntimeBits = "64/32"
+    }
+
+    /*
+     * CREATES NATIVE WINDOWS INSTALLER -- ONLY RUNS ON WINDOWS
+     * Runs the shipped version of Inno Setup (6.2) to compile the installer
+     * Modify the setup settings in native/windows/legup_inno_setup.iss
+     *
+     * Modifications are likely required to run the setup script on your computer:
+     * Edit the "CHANGE ME" line in native/windows/legup_inno_setup.iss to reflect
+     * the path to the Java installation you want to ship inside the executable.
+     */
+    register<Exec>("buildNativeWindows") {
+        dependsOn(shadowJar, createExe)
+        workingDir = File("${project.buildDir}/../native/windows")
+        commandLine("cmd", "/c", "make_windows_installer.bat")
+    }
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists