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
Modify README to make script execution commands clearer #496
Conversation
I can see how someone could mistakenly attempt to run all three of these commands at once — good catch! Knowing that each of these commands need to be run individually requires familiarity with Laptop‘s install could easily be a single command, and, in fact it used to be. Instead, Laptop encourages a super-important practice: reading and understanding scripts before running them. Maybe the README should do more to encourage this? I like @Charliemowood‘s proposed change, but, in addition, I‘d favor reworking the "download, review, then execute" annotation to encourage the best practice even more strongly: InstallDownload the script: curl --remote-name https://raw.githubusercontent.com/thoughtbot/laptop/master/mac Review the script (never run a script you haven‘t read!): less mac Execute the downloaded script: sh mac 2>&1 | tee ~/laptop.log |
@gohanlon I really like the changes you have made and having a clear warning. I would support your improved version with a warning and really explaining what each command does. I think having a review step makes a lot of sense and a single command would not be a good result for the users as it would encourage them to run the script without thinking about it. There is the option of some nice markdown with a clearer warning. Something like: Note:
It might also be nicer to really explain what is meant by |
Based on @gohanlon's suggestions I have expanded the installation instructions hopefully now the installation instructions are more explicit and clear to user as well as encouraging a more thorough review of the script. Here is a preview of the amended README. |
Thanks, @Charliemowood and @gohanlon! I've rebased and merged as 4dcfacf. It uses a version of these instructions that split up the steps into three as suggested, adds the "why" statement of the |
I also added an optional step to review the log. |
It is not overly clear that the commands need to run separately or where they should be run. This minor modification hopefully makes it more clear.