diff --git a/README.md b/README.md index 0804dd6..e69df36 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,16 @@ cd sstv-testbed ``` 4. Check the results in the `output` folder + +Files +----- +A quick rundown of the different files in this repo. +* `run_iq_test.sh` runs `sstv_testbed_iq.grc` on the samples in `samples_iq` +* `run_ogg_test.sh` runs `sstv_testbed_ogg.grc` on the samples in `samples_ogg` +* `render.py` prototype of the rendering code in the decoder block +* `sstv_demod.grc` prototype of the decoder flowgraph, produces `demod.dat` for render.py +* `sstv_pd120_rtl.grc` Receiver flowgraph for live testing with an rtl-sdr +* `sstv_testbed_iq.grc` flowgraph for demodulating `samples_iq` +* `sstv_testbed_ogg.grc` flowgraph for demodulating `samples_ogg` +* `setup_env.sh` stets up some environment variable to make gnuradio find all the shared object files. + May be required on some systems.