From b2b3802463312a64e1779308637b1df8bb13c109 Mon Sep 17 00:00:00 2001 From: Dennis Sheirer Date: Sat, 3 Dec 2022 08:44:11 -0500 Subject: [PATCH] Wiki updates --- Developing.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/Developing.md b/Developing.md index 6970637..fb34c5d 100644 --- a/Developing.md +++ b/Developing.md @@ -1,5 +1,38 @@ # sdrtrunk - Developers/Developing -This wiki will contain details about the sdrtrunk architecture and information for developers that may want to either -contribute to the project or use the source code in other projects. +This wiki will expand to contain details about the sdrtrunk architecture and information for developers that may want +to either contribute to the project, experiment with the source code, or use the source code in other projects. +### OpenJDK +sdrtrunk requires **Java JDK 18 with integrated Open JavaFX** libraries. OpenJDK vendors that I use include: +* [Azul Zulu OpenJDK](https://www.azul.com/downloads/?package=jdk) +* [Bellsoft Liberica OpenJDK](https://bell-sw.com/pages/downloads/#/java-17-lts%20/%20current) +* [SDKMAN](https://sdkman.io/) - not an SDK vendor, rather an SDK selection tool. Linux Only + +Use the gradle wrapper to build the source code: + +### Linux +``` +./gradlew clean build +``` +### Windows +``` +gradlew.bat clean build +``` + +The **/build/distributions** folder will contain the zip file of the compiled program. Unzip it and launch the program from the scripts in the **/bin** directory. + +## Run the Application (from Gradle) + +### Linux +``` +./gradlew clean run +``` +### Windows +``` +gradlew.bat clean run +``` + + +## Development +All dependencies/versions are controlled from build.gradle.