mirror/SDRPlusPlus
0
0
Fork 0
mirror of https://github.com/AlexandreRouma/SDRPlusPlus.git synced 2024-12-26 02:48:31 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

added more info to the readme

Browse Source
This commit is contained in:
Ryzerth 2020-12-14 01:07:30 +01:00
parent 7bea6058fe
commit 3e27af472b
1 changed files with 51 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
readme.md
View File

@ -3,11 +3,15 @@
![Screenshot](https://i.imgur.com/WejsiFN.png)
SDR++ is a cross-platform and open source SDR software with the aim of being bloat free and simple to use.
## Current Features
* [Patreon](https://patreon.com/ryzerth)
* [Discord Server](https://discord.gg/aFgWjyD)
## Features
* Wide hardware support (both through SoapySDR and dedicated modules)
* SIMD accelerated DSP
* Cross-platform
* Cross-platform (Windows, Linux, OSX and BSD)
* Full waterfall update when possible. Makes browsing signals easier and more pleasant
## Comming soon
@ -18,7 +22,9 @@ SDR++ is a cross-platform and open source SDR software with the aim of being blo
* Switchable fft size
* other small customisation options
# Building on Windows
## Requirements
* cmake
@ -30,39 +36,46 @@ SDR++ is a cross-platform and open source SDR software with the aim of being blo
* PothosSDR (for libvolk and SoapySDR)
## The build
```
```powershell
mkdir build
cd build
cmake .. "-DCMAKE_TOOLCHAIN_FILE=C:/Users/Alex/vcpkg/scripts/buildsystems/vcpkg.cmake" -G "Visual Studio 15 2017 Win64"
cmake --build . --config Release
```
## Copying over needed directories
The last step of the build process is copying the `bandplans` and `res` directories to the output directory.
If you followed the steps above, it should be `build/Release`.
# Building on Linux
## install requirements
On Debian/Ubtuntu system:
apt install libglew-dev libglfw3-dev libfftw3-dev libvolk1-dev portaudio19-dev libsoapysdr-dev gcc
## The build
```
Replace `<N>` by the number of threads available for building (eg. 4)
```sh
mkdir build
cd build
cmake ..
make
make -j<N>
```
## Modify root_dev/modules_list.json
If the content is different than the following, change it.
```
{
"Radio": "./radio/radio.so",
"Recorder": "./recorder/recorder.so",
"Soapy": "./soapy/soapy.so",
"RTLTCPSource": "./rtl_tcp_source/rtl_tcp_source.so"
}
## Modify root_dev/config.json
You'll then need to set the right paths for the modules.
This is optional. If you don't plan on modifying the modules,
you can simply copy over their binaries (from `build/<module name>/<module name>.so`)
to the `root_dev/modules/` directory.
Here is an example of module paths in `root_dev/config.json`
```json
"modules": [
"./radio/radio.so",
"./recorder/recorder.so",
"./soapy/soapy.so",
"./rtl_tcp_source/rtl_tcp_source.so"
]
```
# Building on OSX
@ -82,8 +95,28 @@ cmake ..
cmake --build . --config Release
```
## Configuring
You'll then need to set the right paths for the modules.
This is optional. If you don't plan on modifying the modules,
you can simply copy over their binaries (from `build/<module name>/<module name>.so`)
to the `root_dev/modules/` directory.
Here is an example of module paths in `root_dev/config.json`
```json
"modules": [
"./radio/radio.so",
"./recorder/recorder.so",
"./soapy/soapy.so",
"./rtl_tcp_source/rtl_tcp_source.so"
]
```
# Building on OpenBSD
## Install requirements
NOTE: These instructions are outdated
```
pkg_add fftw3-float glew glfw portaudio-svn