From efe36b0682147a9001c58c37b63e67ba68928d35 Mon Sep 17 00:00:00 2001 From: Dennis Sheirer Date: Sat, 3 Dec 2022 09:28:12 -0500 Subject: [PATCH] Updates README --- README.md | 81 +++++-------------------------------------------------- 1 file changed, 6 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 7ab5b4a75..e9c478be8 100644 --- a/README.md +++ b/README.md @@ -3,91 +3,22 @@ # sdrtrunk A cross-platform java application for decoding, monitoring, recording and streaming trunked mobile and related radio protocols using Software Defined Radios (SDR). -* [Getting Started](https://github.com/DSheirer/sdrtrunk/wiki/GettingStarted_V0.3.0) -* [User's Manual Version 0.3.0 and 0.4.0](https://github.com/DSheirer/sdrtrunk/wiki/UserManual_V0.3.0) -* [Playlist Editor User Manual Version 0.5.0](https://github.com/DSheirer/sdrtrunk/wiki/Playlist-Editor) +* [Getting Started](https://github.com/DSheirer/sdrtrunk/wiki/Getting-Started) +* [User's Manual](https://github.com/DSheirer/sdrtrunk/wiki/User-Manual) * [Download](https://github.com/DSheirer/sdrtrunk/releases) -* [Support Group](https://groups.google.com/forum/#!forum/sdrtrunk) -* [Discord Support Channel](https://discord.gg/HJQaKYE) +* [Support](https://github.com/DSheirer/sdrtrunk/wiki/Support) -![sdrtrunk Application Overview - Version 0.3.0](https://github.com/DSheirer/sdrtrunk/wiki/v0.3/images/ApplicationOverview_V0.3.0.png) -**Figure 1:** sdrtrunk **Version 0.3.0** Application Screenshot +![sdrtrunk Application](https://github.com/DSheirer/sdrtrunk/wiki/images/sdrtrunk.png) +**Figure 1:** sdrtrunk Application Screenshot -# End User Instructions: - -If you simply want to download and run the program, please follow these instructions. - -## Download the latest sdrtrunk release for your operating system - +## Download the Latest Release All release versions of sdrtrunk are available from the [releases](https://github.com/DSheirer/sdrtrunk/releases) tab. * **(alpha)** These versions are under development feature previews and likely to contain bugs and unexpected behavior. * **(beta)** These versions are currently being tested for bugs and functionality prior to final release. * **(final)** These versions have been tested and are the current release version. -## Unzip the release - -Use 7-zip or any zip utility to unzip the release file - -## Start the application - -Once unzipped, open a command prompt to where you unzipped the release. Change to the **/bin** directory and use the launch script to start the application: -* **Windows** sdr-trunk.bat -* **Linux/OSX** ./sdr-trunk - -## Optional - P25/DMR Audio -If you're using sdrtrunk with a P25 or DMR radio system, you'll need to compile and include the [JMBE](https://github.com/DSheirer/sdrtrunk/wiki/JMBE) digital audio library. - -In Version 0.5.0 and higher, the SDRTrunk application has support for building the JMBE library. On the menu, choose **View >> User Preferences** and then click the **Decoder >> JMBE Audio Library** tab. - -For versions prior to Version 0.5.0, the [JMBE](https://github.com/DSheirer/sdrtrunk/wiki/JMBE) wiki page contains instructions for downloading the JMBE audio library source code and compiling the JMBE library. Once you have compiled the library, launch the sdrtrunk application. From the menu bar, choose **View >> Preferences**. In the **JMBE Audio Codec** section, update the path to where your compiled JMBE library is located. Any channels that are started after you set the path will be able to produce P25 audio. - ## Minimum System Requirements * **Operating System:** Windows (~~32 or~~ 64-bit), Linux (~~32 or~~ 64-bit) or Mac/Linux (64-bit, 10.14 or higher) * **CPU:** 4-core * **RAM:** 8GB or more (preferred). Depending on usage, 4GB may be sufficient. - -# Developer Instructions: - -If you're interested in modifying and/or compiling the source code, please follow these instructions to use gradle to compile the code. - -## Build the project -sdrtrunk uses the gradle build system. This requires **OpenJDK 17** or higher installed on your local computer. - -### OpenJDK -There are many vendors producing OpenJDK distributions. A few that I use are: -* [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/) - 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. -To change the new release version tag of artifact - change property: -``` -version = '0.5.0' -```