README.md
1# Digital Ham Radio decoding tools
2
3This a simple set of command-line tools that is intended to be used to decode digital modulations used by ham radio
4operators. The main focus is on digital voice modes.
5
6Right now this project enables you to decode DMR and YSF, future plans include NXDN and D-Star.
7
8The main use of this project is to run in the backend of [OpenWebRX](https://github.com/jketterl/openwebrx), where it
9decodes the available information, which is then displayed on the receiver's website.
10
11## Requirements
12
13Most digital voice modes in the ham radio universe right now use some version of the AMBE digital voice codec. In order
14to decode them, you will need to install [mbelib](https://github.com/szechyjs/mbelib).
15
16## Installation
17
18This project comes with a cmake build. It is recommended to build in a separate directory.
19
20```
21mkdir build
22cd build
23cmake ..
24make
25sudo make install
26```
27
28## Examples
29
30You can find shell scripts that show the basic usage of the components in the `examples` folder.