diff options
| author | knoflook <knoflook@disroot.org> | 2022-03-27 10:43:56 +0200 |
|---|---|---|
| committer | knoflook <knoflook@disroot.org> | 2022-03-27 11:13:21 +0200 |
| commit | df1a20bd1d2a17f3261a6413e62e55301135ecd5 (patch) | |
| tree | 366a534edc2e7d3619298d1b2fcf579981ec2c62 | |
| parent | 3c89941688a9add325567488730f896808e355c9 (diff) | |
docs: add install and usage instructions
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
@@ -1,2 +1,26 @@ # libsstv SSTV C encoder/decoder library for embedded systems. + +## Usage: +``` +./sstv-encode + -input (input image) type: string default: "" + -mode (SSTV mode for encoder) type: string default: "" + -output (output WAV file) type: string default: "" + -sample_rate (output audio sample rate) type: uint64 default: 48000 +``` + +## Install + +install dependencies (tested on devuan 4 chimaera - debian 11 bullseye based and debian 11 on raspberry pi): +``` +sudo apt update +sudo apt install libgoogle-glog-dev libgflags-dev libmagick++-dev libsndfile1-dev make cmake +``` +go to the `bin` folder, run cmake and then compile with make: +``` +cd bin +cmake .. +make +``` +now you can run `./sstv-encode` |