summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVasile Vilvoiu <vasi.vilvoiu@gmail.com>2022-03-29 22:02:05 +0300
committerGitHub <noreply@github.com>2022-03-29 22:02:05 +0300
commit817b1f35d11b46b2ab11987dc8682a04c71aaee4 (patch)
tree366a534edc2e7d3619298d1b2fcf579981ec2c62
parent02167a4c8c4dd3320427ba804cee5701cb9be79b (diff)
parentdf1a20bd1d2a17f3261a6413e62e55301135ecd5 (diff)
Merge pull request #8 from p00rt/master
Add some documentation, fix runtime error Thank you for your contribution!
-rw-r--r--README.md24
-rw-r--r--src/tools/sstv-encode.cpp4
2 files changed, 26 insertions, 2 deletions
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`
diff --git a/src/tools/sstv-encode.cpp b/src/tools/sstv-encode.cpp
index b211e9f..9acbc57 100644
--- a/src/tools/sstv-encode.cpp
+++ b/src/tools/sstv-encode.cpp
@@ -18,7 +18,7 @@
/*
* Command line flags
*/
-DEFINE_bool(logtostderr, false, "Only log to stderr");
+//DEFINE_bool(logtostderr, false, "Only log to stderr");
DEFINE_string(mode, "", "SSTV mode for encoder");
DEFINE_string(input, "", "input image");
DEFINE_string(output, "", "output WAV file");
@@ -227,4 +227,4 @@ int main(int argc, char **argv)
/* all ok */
LOG(INFO) << "Successfuly exited";
return 0;
-} \ No newline at end of file
+}