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

Suggestions to make using Run more clear #80

Closed
Gys opened this issue Oct 8, 2024 · 2 comments · Fixed by #81
Closed

Suggestions to make using Run more clear #80

Gys opened this issue Oct 8, 2024 · 2 comments · Fixed by #81

Comments

@Gys
Copy link

Gys commented Oct 8, 2024

Hi

I had not used this tool for a while and was trying to remember how to use it. I also tried to google it, but 'run' and 'Runfile' are very common words...

So I suggest you add a link to your project in the help screen. Plus an option to create a example Runfile with some comments for possible use cases.

@Gys
Copy link
Author

Gys commented Oct 8, 2024

Ok, have the latest version now and that includes the project. Good one! Still, I think an example Runfile would be nice to get started more quickly in new projects.

@TekWizely
Copy link
Owner

Greetings @Gys !

Thank you for taking the time to create an issue, and double-thanks for taking time to upgrade to latest version to see if your concerns were addressed.

re: Samples

I'd be reluctant to ship a sample Runfile in the binary as it feels a bit wasteful.

The Examples section on the README is pretty thorough.

You could imagine an examples/ folder in the repo, but not sure it would be valuable if it was based on the same samples as the README.

If it contained some useful real-word examples or templates, that could be very interesting, and possibly related to #8 .

Perhaps it may be enough to update messaging beside the link within help to also state that there are examples to be found, maybe something like:

Learn more about run (including example Runfiles) at https://github.com/TekWizely/run"

Lemme know what you think and thanks again for taking the time!

Q: I'd be interested in knowing how you're using Run in your own projects?

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 a pull request may close this issue.

2 participants