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

Modify README to make script execution commands clearer #496

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 20 additions & 6 deletions README.md
Expand Up @@ -23,13 +23,27 @@ Bug reports for older versions are welcome.
Install
-------

Download, review, then execute the script:
The following commands should be run in Terminal.

```sh
curl --remote-name https://raw.githubusercontent.com/thoughtbot/laptop/master/mac
less mac
sh mac 2>&1 | tee ~/laptop.log
```

1. You the will need to download the script, the script will be downloaded into your current directory using the `curl` command, choose an appropriate location such as your home directory `~/`, when you are ready, run the command:
```sh
curl --remote-name https://raw.githubusercontent.com/thoughtbot/laptop/master/mac
```

2. The `less` command will display to you in Terminal the content of the script. Review the script by running the command and read through the script:

> It is very important that you read through every script that you run on your operating system. Scripts can make make major changes that you did not intend. Please review this script carefully before running this script on your system.

```sh
less mac
```

3. Finally, when you are satisfied with the script, you can execute it. Be aware that you can access the log at the location `~/laptop.log`. You can use the log to see exactly what the script has been able to achieve or diagnose any issues. Run the following command to execute the script:

```sh
sh mac 2>&1 | tee ~/laptop.log
```

Optionally, [install thoughtbot/dotfiles][dotfiles].

Expand Down