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

Update install instructions in README #143

Merged
merged 2 commits into from
Oct 10, 2023
Merged

Conversation

MasloMaslane
Copy link
Member

Some people didn't know that ~/.local/bin has to be in PATH

@MasloMaslane MasloMaslane requested a review from tonowak October 9, 2023 14:17
@MasloMaslane MasloMaslane self-assigned this Oct 9, 2023
@tonowak
Copy link
Collaborator

tonowak commented Oct 9, 2023

I'm not sure whether it's sufficient. What if someone doesn't know what a PATH is, or how to add the path to PATH? Can we link something that explains everything?

@MasloMaslane
Copy link
Member Author

@tonowak
Copy link
Collaborator

tonowak commented Oct 9, 2023

Maaybee. It's more than just explaining PATH etc, as it contains some useless information about installations. To see how to add something to the PATH, the user needs to go through one more link inside of it. It would be nice to have something better, but if not, I'm fine with this.

@MasloMaslane
Copy link
Member Author

What about this https://gist.github.com/nex3/c395b2f8fd4b02068be37c961301caa7 ? Then readme could look like this:

pip installs sinol-make executable in ~/.local/bin/ directory, so make sure it's in your PATH. Here's how to add a directory to PATH.

@tonowak
Copy link
Collaborator

tonowak commented Oct 9, 2023

Looks good!

Slight suggestions:

installs sinol-make executable in -> installs the sinol-make executable in the

so make sure it's in your -> so make sure this directory is in your

@MasloMaslane MasloMaslane merged commit 7c53054 into main Oct 10, 2023
8 checks passed
@MasloMaslane MasloMaslane deleted the better-install-instructions branch October 10, 2023 09:15
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