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

Added options (-howtouse and -credits), updated way to start app, and found fix to random options error (ex: -B) #32

Merged
merged 3 commits into from
May 11, 2024

Conversation

moonsdust
Copy link
Member

@moonsdust moonsdust commented May 11, 2024

In this PR, the CLI was updated so that it 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))

This will be added soon into #21 but in order to start the app, you no longer need to use the start command and instead just use the command ./streetwhisperapp (if running the generated exe) or python streetwhisperapp (if running the script).

If you are generating an executable file, to stop error messages from showing up during the translation/transcription process like "No such option: -B", etc., see #29.

@moonsdust moonsdust requested a review from carmen-chau May 11, 2024 04:14
@moonsdust moonsdust linked an issue May 11, 2024 that may be closed by this pull request
@moonsdust moonsdust changed the title Added options (-howtouse and -credits) and found fix to random options error (ex: -B) Added options (-howtouse and -credits), updated way to start app, and found fix to random options error (ex: -B) May 11, 2024
Copy link
Collaborator

@carmen-chau carmen-chau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@moonsdust
Looks good Emily. I still have to test this with the EXE generation, but I figure potential problems arising from that deserves an issue + PR of its own.

Futhermore this may or may not trigger the -B error again in #29, hence the reason for a seperate PR if need be.

IMO I think it's ok to go ahead and merge for now, but feel free to not if you prefer

@moonsdust moonsdust merged commit f50e545 into main May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: Adding more options to CLI
2 participants