street-lab-tech / street-whisper-app

STREET Lab Whisper App - a tool that transcribes and translates audio files into CSV files.
MIT License
2 stars 0 forks source link

Documentation addition: Revise README.md (and/or the "help"/"how to use" feature from the CLI) with new instructions #21

Open carmen-chau opened 4 months ago

carmen-chau commented 4 months ago

General list of additional information / instructions to add:

Picture reference:

Screenshot 2024-04-29 at 4 24 20 PM

Picture for reference:

Screenshot 2024-04-29 at 4 02 00 PM
carmen-chau commented 4 months ago

Please feel free to add more documentation improvements here (or in another document if prefered)

moonsdust commented 4 months ago

The README.md needs to be updated with the following:

The CLI currently supports the following options:

To start up the app, run the following command: ./streetwhisperapp (if running the generated exe) or python streetwhisperapp (if running the script).