Added Readme

Did some cleanups
2020-01-12 21:07:07 +01:00 · 2020-01-12 21:07:07 +01:00 · 52d00a4a67
parent 3ba3e25f0e
commit 52d00a4a67
4 changed files with 34 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,34 @@
+SSTV Testbed
+============
+
+Testbed for the satnogs PD120 decoder.
+
+The flowgraphs in the repository are kept as close as possible to the PD120 observation flowgraph
+in [gr-satnogs](https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/).
+The repo also contains some audio and IQ samoles to test the decoder.
+
+Running the Tests
+-----------------
+1. Checkout the testbed repo
+```
+git clone git@gitlab.com:LongHairedHacker/sstv-testbed.git
+```
+
+2. Compile and setup gr-satnogs
+```
+git clone git@gitlab.com:librespacefoundation/satnogs/gr-satnogs.gi
+cd gr-satnogs
+mkdir build
+cd build
+cmake ..
+sudo make install
+```
+
+3. Run the flowgraphs
+```
+cd sstv-testbed
+./run_ogg_test.sh
+./run_iq_test.sh
+```
+
+4. Check the results in the `output` folder
--- a/run_iq_test.sh
+++ b/run_iq_test.sh
--- a/run_ogg_test.sh
+++ b/run_ogg_test.sh
--- a/samples_ogg/satnogs_1446993_2019-12-29T12-32-38.ogg
+++ b/samples_ogg/satnogs_1446993_2019-12-29T12-32-38.ogg