From df1a20bd1d2a17f3261a6413e62e55301135ecd5 Mon Sep 17 00:00:00 2001 From: knoflook Date: Sun, 27 Mar 2022 10:43:56 +0200 Subject: docs: add install and usage instructions --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 666fe1b..36143c7 100644 --- a/README.md +++ b/README.md @@ -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` -- cgit v1.2.3