Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
carmen-chau opened this issue Apr 29, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@carmen-chau
Copy link
Collaborator

carmen-chau commented Apr 29, 2024

General list of additional information / instructions to add:

  • If the user does not have models--pyannote--speaker-diarization-3.1 located in their .cache folder, then the CLI would download it first. This leads to a progress bar (with no label) showing up). Users should be made aware about this.

Picture reference:

Screenshot 2024-04-29 at 4 24 20 PM
  • If the user does not have the desired whisper .pt file in their local .cache folder, then a progress bar would show up during the running of method define_whisper_model. There is no label to this progress bar, so users should be aware about what this progress bar is.

Picture for reference:
Screenshot 2024-04-29 at 4 02 00 PM

@carmen-chau carmen-chau added the documentation Improvements or additions to documentation label Apr 29, 2024
@carmen-chau
Copy link
Collaborator Author

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

@carmen-chau carmen-chau changed the title Minor: Revise README.md with new CLI instructions Documentation addition: Revise README.md (and/or the "help" feature from the CLI) with new instructions Apr 29, 2024
@moonsdust moonsdust changed the title Documentation addition: Revise README.md (and/or the "help" feature from the CLI) with new instructions Documentation addition: Revise README.md (and/or the "help"/"how to use" feature from the CLI) with new instructions May 11, 2024
@moonsdust
Copy link
Member

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

The CLI currently supports the following options:

  • -howtouse: Explains how to use tool (To use this, run the following command: ./streetwhisperapp -howtouse (if with generated exe) or python streetwhisperapp -howtouse (if directly interacting with the script))
  • -credits: Credits section (To use this, run the following command: ./streetwhisperapp -credits (if with generated exe) or python streetwhisperapp -credits (if directly interacting with the script))
  • --help: Shows all the options available (To use this, run the following command: ./streetwhisperapp --help (if with generated exe) or python streetwhisperapp --help (if directly interacting with the script))

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants