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

Executing instructions added to README #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

PinkSerenity
Copy link

I added some basic instructions on how to run the program to the README.md. It just covers the basics, but especially for Windows users who don't know how to run a Python script it should suffice.

I added some basic instructions on how to run the program to the README.md. It just covers the basics, but especially for Windows users who don't know how to run a Python script it should suffice.
@sonic2kk
Copy link
Contributor

Just my two-cents as a user: I think having platform-agnostic steps is better (i.e. "From the command line, navigate to the folder with the script and run python3 main.py - though even python3 is not guaranteed to be universal), but at the very least perhaps mentioning that these steps are for Windows might be better. For example, "On Windows, you can do [...]"

Just my thoughts here :-)

@PinkSerenity
Copy link
Author

Just my two-cents as a user: I think having platform-agnostic steps is better (i.e. "From the command line, navigate to the folder with the script and run python3 main.py - though even python3 is not guaranteed to be universal), but at the very least perhaps mentioning that these steps are for Windows might be better. For example, "On Windows, you can do [...]"

Didn't I kinda do both of that? Sure, the universal sentence is pretty short, but there isn't much to add to it. The Windows explanation (I mentioned Windows) is a bit longer, because I described the context menu shortcut in the Explorer there. I don't know whether something like that exists on Mac or Linux (and for users of the latter the terminal instructions probably suffice).

@sonic2kk
Copy link
Contributor

Well fair, maybe I'm just nitpicking too much :-)

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.

2 participants