diff --git a/README.md b/README.md index b3016af..4d97e80 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,62 @@ -# ovgenpy +# Corrscope Python program to render wave files into oscilloscope views, featuring improved correlation-based triggering algorithm + + ## Dependencies -- Python 3.6 or above (3.5 will not work) - FFmpeg ## Installation - -### Conda + + +## GUI Tutorial + +1. Open GUI: + - `corrscope.exe` to create new project + - `corrscope.exe file.yaml` to open existing project +1. Add audio to play back + - On the right side of the window, click "Browse" to pick a master audio file. +1. Add oscilloscope channels + - On the right side of the window, click "Add" to add WAV files to be viewed. +1. Edit settings + - Global settings on the left side of the window + - Per-channel on the right side +1. Play or render to MP4/etc. video (requires ffmpeg) + - Via toolbar or menu + ## Command-line Tutorial 1. Create YAML: - - `python -m ovgenpy split*.wav --audio master.wav -w` + - `corrscope split*.wav --audio master.wav -w` - Specify all channels on the command line. - `-a` or `--audio` specifies master audio track. - Creates file `master.yaml`. @@ -37,7 +64,7 @@ pip install -e . 1. Edit `master.yaml` to change settings. 1. Play (requires ffmpeg): - - `...ovgenpy master.yaml -p/--play` + - `corrscope master.yaml -p/--play` 1. Render and encode MP4 video (requires ffmpeg) -- `...ovgenpy master.yaml -r/--render` + - `corrscope master.yaml -r/--render`