You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit clarifies how Gradle support is more version dependent and guides users in the getting started doc toward using the first two installation options and away from SDKMAN if they aren't developers.
The developer notes are also updated to include information about Gradle versioning in relation to Java versions with a helpful link.
Copy file name to clipboardExpand all lines: docusaurus/docs/Contributing/developer-guidelines.md
+7-1Lines changed: 7 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,14 +31,19 @@ While there are plenty of developer tools available for Java developers, this pa
31
31
We write exclusively in Java or Java-compiled languages without any operating-system specific packages (to maintain portability across machines).
32
32
33
33
### SDKMAN!
34
-
Olivia recommends installing Java using [SDKMAN!][sdkman] for convenient flipping between Java versions. While ScriptManager is currently developed to the Java 8 SE standard, it is good practice to check for forward and backward compatibility between Java versions. We are constantly monitoring new Java releases and developing according to a standard that is consistent across Java versions makes our lives easier down the road when the Java version standard is incremented.
34
+
Olivia recommends installing Java using [SDKMAN!][sdkman] for convenient flipping between Java versions and releases. While ScriptManager is currently developed to the Java 8 SE standard, it is good practice to check for forward and backward compatibility between Java versions. We are constantly monitoring new Java releases and developing according to a standard that is consistent across Java versions makes our lives easier down the road when the Java version standard is incremented.
35
35
36
36
### Integrated Development Environment (IDE) - Eclipse
37
37
We recommend using [Eclipse][eclipse] to write Java code for ScriptManager because it supports both [Gradle][gradle] (see below) and [WindowBuilder][window-builder] for convenient building of JAR files and graphical interface development.
38
38
39
39
### Gradle-based build
40
40
Compiling Java classes and building JAR files could be handled manually, but for this project, we let Gradle juggle the process of compiling, retrieving dependencies, and building the final JAR file. The dependencies we use are a mix of downloaded JAR files (`scriptmanager/lib/*.jar` and dependencies retrieved directly from [Maven][maven]).
41
41
42
+
Gradle will need to be updated periodically to support *building* on later Java versions.
43
+
44
+
:::caution
45
+
Please note the minimum Java version required to support building the JAR executable. Code compiling with Gradle creates an upper Java version limit depending on the version of Gradle used. See this [table][gradle-version-compatibility] for more information on version compatibility.
46
+
:::
42
47
43
48
## The Code Structure (Packages)
44
49
```
@@ -153,6 +158,7 @@ The [Release Roadmap][release-roadmap] on Github organizes issue tickets and cre
Copy file name to clipboardExpand all lines: docusaurus/docs/Guides/getting-started.md
+14-7Lines changed: 14 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,17 +15,20 @@ Both Graphical User Interface (GUI) and Command Line Interface (CLI) execution o
15
15
16
16
### Java
17
17
18
-
This tool is a Java-based tool and has been developed for Java versions 8 or higher. Most machines already have Java installed! So check if you've got it first!
18
+
This tool is a Java-based tool and has been developed to run using Java versions 8 or higher. Set up Java on your machine in one of many ways...
19
19
20
-
There are many ways to set up Java on your machine but we are just including three ways below:
20
+
***Option A:** Download [OpenJDK for Java 11][temurin-11] (recommend for novice users)
21
21
22
-
1. Download [OpenJDK for Java 8][openjdk] (recommend for novice users)
23
-
2. Create a [conda][conda-openjdk] environment with Java:
22
+
***Option B:** If you have Anaconda set up on a Unix/MacOS system, create a [conda][conda-openjdk] environment with Java using the following command:
24
23
```
25
24
conda install -n my-env -c conda-forge openjdk
26
25
```
27
-
3. ...or use [SDKMAN!][sdk-notes] (what Olivia does)
28
26
27
+
Feel free to use whatever Java installation method you are most comfortable with. Most machines already have Java installed! **So check if you've got it first!**
28
+
29
+
:::note
30
+
**For Developers:** If you are writing code for scriptmanager and need to flip between Java versions to perform testing across different versions and releases, consider using [SDKMAN!][sdk-notes] (what Olivia does).
31
+
:::
29
32
30
33
## Set-up: Download Executable and Start
31
34
There are two ways to obtain the ScriptManager executable JAR file.
@@ -49,8 +52,12 @@ cd scriptmanager
49
52
50
53
The ScriptManager jar file will be created in the `build/libs` directory. As long as you have this file, you can move it wherever you want and do whatever you want with the rest of the ScriptManager files (even delete them). If you ever lose the JAR file, you can regenerate it by rerunning the Gradle build command in while in the `scriptmanager` directory.
51
54
55
+
:::caution
56
+
Please note that the latest **Java version** may not be compatible our supported Gradle version to compile. The JAR can be *executed* on most versions but compiling the code may require installing an older version of Java. Consider directly downloading the JAR executable (instructions above) if these steps aren't working.
57
+
:::
58
+
52
59
### Update the Github repository (update to latest dev version)
53
-
If you ever need to update to get the latest code from the Github repo, just navigate to the `scriptmanager` directory and run the following commands to update and then re-build your JAR executable.
60
+
If you ever need to get the latest code from the Github repo, just navigate to the `scriptmanager` directory and run the following commands in the terminal to update and then re-build your JAR executable.
54
61
```bash
55
62
cd scriptmanager
56
63
git pull
@@ -124,7 +131,7 @@ If you use ScriptManager in your work, you can use the [Lang et al (2022)][pearc
124
131
We welcome anyone who uses ScriptManager for analysis in their publications to let us know by sending an email to owl8@cornell.edu so we can list it in our [showcase of publications][publications-list]!
0 commit comments