search

tralph3 / Steam-Metadata-Editor

An easy to use GUI that edits the metadata of your Steam Apps
GNU General Public License v3.0
161 stars 18 forks source link

Executing instructions added to README #32

Open PinkSerenity opened 1 year ago

PinkSerenity commented 1 year ago

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 commented 9 months ago

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 commented 9 months ago

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 commented 9 months ago

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