mirror of
https://github.com/DSheirer/sdrtrunk.git
synced 2026-11-16 18:47:33 -05:00
Update README.md
This commit is contained in:
56
README.md
56
README.md
@@ -13,68 +13,48 @@ A cross-platform java application for decoding, monitoring, recording and stream
|
|||||||
|
|
||||||
If you simply want to download and run the program, please follow these instructions.
|
If you simply want to download and run the program, please follow these instructions.
|
||||||
|
|
||||||
## Install Java 8 (or newer)
|
## Download the latest sdrtrunk release for your operating system
|
||||||
|
|
||||||
## Download the latest sdrtrunk release
|
|
||||||
|
|
||||||
All release versions of sdrtrunk are available from the [releases](https://github.com/DSheirer/sdrtrunk/releases) tab.
|
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.
|
**(final)** These versions have been tested and are the current release version.
|
||||||
|
|
||||||
**(alpha)** These versions are under development feature previews and likely to contain bugs and unexpected behavior.
|
## Unzip the release
|
||||||
|
|
||||||
**(beta)** These versions are currently being tested for bugs and functionality.
|
Use 7-zip or any zip utility to unzip the release file
|
||||||
|
|
||||||
## Run the application
|
## Start the application
|
||||||
|
|
||||||
Either double-click on the downloaded file (if supported on your operating system) or open a terminal/command window
|
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:
|
||||||
and change to the directory where you downloaded the release file and type:
|
**Windows** sdr-trunk.bat
|
||||||
|
**Linux/OSX** ./sdr-trunk
|
||||||
```
|
|
||||||
java -jar downloaded-jar-filename
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: replace _downloaded-jar-filename_ with the actual name of the sdrtrunk release version that you downloaded
|
|
||||||
|
|
||||||
## Optional - P25 Audio
|
## Optional - P25 Audio
|
||||||
If you're using sdrtrunk with a P25 trunked radio system, the [JMBE](https://github.com/DSheirer/sdrtrunk/wiki/JMBE) wiki page contains instructions
|
If you're using sdrtrunk with a P25 trunked radio system, 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.
|
||||||
for downloading the JMBE audio library source code and compiling the JMBE library. Copy the resulting JMBE audio library
|
|
||||||
jar file to the same folder containing the sdrtrunk application to use the library with sdrtrunk.
|
|
||||||
|
|
||||||
# Developer Instructions:
|
# 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.
|
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
|
## Build the project
|
||||||
sdrtrunk uses gradle as the build system. You can build it with locally installed gradle or if you do not have/want
|
sdrtrunk uses the gradle build system. This requires OpenJDK 11 or higher installed on your local compuber. Use the gradle wrapper to build the source code:
|
||||||
to install gradle you can use preconfigured linux/windows wrapper.
|
|
||||||
|
|
||||||
### Build with locally installed gradle 4.3.1
|
### Linux
|
||||||
```
|
```
|
||||||
gradle clean buildSdr
|
./gradlew clean build
|
||||||
```
|
```
|
||||||
### Build with preconfigured wrapper for linux/windows
|
### Windows
|
||||||
Linux
|
|
||||||
```
|
```
|
||||||
./gradlew clean buildSdr
|
gradlew.bat clean build
|
||||||
```
|
```
|
||||||
Windows
|
|
||||||
```
|
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.
|
||||||
gradlew.bat clean buildSdr
|
|
||||||
```
|
|
||||||
This would add gradle, download all project dependencies and build JAR
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
All dependencies/versions are controlled from build.gradle.
|
All dependencies/versions are controlled from build.gradle.
|
||||||
To change the new release version tag of artifact - change property:
|
To change the new release version tag of artifact - change property:
|
||||||
```
|
```
|
||||||
version = '0.3.2'
|
version = '0.4.0'
|
||||||
```
|
|
||||||
|
|
||||||
## Run SDRTrunk
|
|
||||||
SDRTrunk is packed into single uber-jar file. There is need to have folders with dependencies and
|
|
||||||
adding them with classpath. Just run with java.
|
|
||||||
### Use Java8
|
|
||||||
```
|
|
||||||
java -jar build/libs/sdr-trunk-all-0.3.2.jar
|
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user