diff --git a/README.md b/README.md index 3b10f06e..2e0d0813 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,43 @@ A cross-platform java application for decoding, monitoring, recording and stream ![sdrtrunk Application Overview - Version 0.3.0](https://github.com/DSheirer/sdrtrunk/wiki/images/ApplicationOverview_V0.3.0.png) **Figure 1:** sdrtrunk **Version 0.3.0** Application Screenshot -# Instructions: +# End User Instructions: + +## Install Java 8 (or newer) + +## Download the latest sdrtrunk release + +All release versions of sdrtrunk are available from the [releases](https://github.com/DSheirer/sdrtrunk/releases) tab. + +**(final)** These versions have been tested and are the current release version. + +**(beta)** These versions are currently being tested for bugs and functionality. + +## Run the application + +Either double-click on the downloaded file (if supported on your operating system) or open a terminal/command window +and change to the directory where you downloaded the release file and type: + +``` +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 +If you're using sdrtrunk with a P25 trunked radio system, the [JMBE](JMBE) wiki page contains instructions +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: + +If you're interested in downloading and compiling the source code, please follow these +instructions to use gradle to compile the code. + ## Build the project -Project uses gradle as build system. You can build it with locally installed gradle or if you do not have/want install gradle you can use preconfigured linux/windows wrapper. +sdrtrunk uses gradle as the build system. You can build it with locally installed gradle or if you do not have/want +to install gradle you can use preconfigured linux/windows wrapper. + ### Build with locally installed gradle 4.3.1 ``` gradle clean buildSdr @@ -35,20 +69,9 @@ version = '0.3.2' ``` ## Run SDRTrunk -SDRTrunk is packed into single uber-jar file. There is need to have folders with dependecies and +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 ``` - -## TODO ITEMS - -- [x] Move project to gradle build -- [x] Changed folders structure, based on java project -- [x] Dependencies are moved to gradle and versions are updated -- [x] Create uberJAR with all dependencies -- [ ] Some dependencies left in imports folder. Find them and include into gradle -- [ ] Move images into resources of project -- [ ] Add tests to project. This would guarantee that after refactoring part of functionality is not broken -- [ ] Create modular OOP system (radio-module, gui, web-ui, etc). This would allow to use RADIO modules to call from CLI, GUI or Web UI. And use SDRTrunk as dependency for other projects. \ No newline at end of file