c8ac4038cf41112161de984d3f7eef8579eb085e

Message

installer: add documentation of new installer features to README

Diff

This diff is truncated to protect this page.

  1diff --git a/README.md b/README.md
  2index 38f6ae9f318733b77dc2ab070f6f7e84b28bd4bf..3924c3a920c6e233529f5f4318fc097c0cb8173c 100644
  3--- a/README.md
  4+++ b/README.md
  5@@ -38,7 +38,18 @@ sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/mas
  6 #### via wget
  7 
  8 ```shell
  9-sh -c "$(wget https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh -O -)"
 10+sh -c "$(wget -O- https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
 11+```
 12+
 13+#### Manual inspection
 14+
 15+It's a good idea to inspect the install script from projects you don't yet know. You can do
 16+that by downloading the install script first, looking through it so everything looks normal,
 17+then running it:
 18+
 19+```shell
 20+curl -Lo install.sh https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh
 21+sh install.sh
 22 ```
 23 
 24 ## Using Oh My Zsh
 25@@ -69,6 +80,8 @@ plugins=(
 26 )
 27 ```
 28 
 29+_Note that the plugins are separated by whitespace. **Do not** use commas between them._
 30+
 31 #### Using Plugins
 32 
 33 Most plugins (should! we're working on this) include a __README__, which documents how to use them.
 34@@ -124,16 +137,53 @@ If you're the type that likes to get their hands dirty, these sections might res
 35 
 36 ### Advanced Installation
 37 
 38-Some users may want to change the default path, or manually install Oh My Zsh.
 39+Some users may want to manually install Oh My Zsh, or change the default path or other settings that
 40+the installer accepts (these settings are also documented at the top of the install script).
 41 
 42 #### Custom Directory
 43 
 44 The default location is `~/.oh-my-zsh` (hidden in your home directory)
 45 
 46-If you'd like to change the install directory with the `ZSH` environment variable, either by running `export ZSH=/your/path` before installing, or by setting it before the end of the install pipeline like this:
 47+If you'd like to change the install directory with the `ZSH` environment variable, either by running
 48+`export ZSH=/your/path` before installing, or by setting it before the end of the install pipeline
 49+like this:
 50+
 51+```shell
 52+ZSH="$HOME/.dotfiles/oh-my-zsh" sh install.sh
 53+```
 54+
 55+#### Unattended install
 56+
 57+If you're running the Oh My Zsh install script as part of an automated install, you can pass the
 58+flag `--unattended` to the `install.sh` script. This will have the effect of not trying to change
 59+the default shell, and also won't run `zsh` when the installation has finished.
 60 
 61 ```shell
 62-export ZSH="$HOME/.dotfiles/oh-my-zsh"; sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
 63+curl -Lo install.sh https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh
 64+sh install.sh --unattended
 65+```
 66+
 67+#### Installing from a forked repository
 68+
 69+The install script also accepts these variables to allow installation of a different repository:
 70+
 71+- `REPO` (default: `robbyrussell/oh-my-zsh`): this takes the form of `owner/repository`. If you set
 72+  this variable, the installer will look for a repository at `https://github.com/{owner}/{repository}`.
 73+
 74+- `REMOTE` (default: `https://github.com/${REPO}.git`): this is the full URL of the git repository
 75+  clone. You can use this setting if you want to install from a fork that is not on GitHub (GitLab,
 76+  Bitbucket...) or if you want to clone with SSH instead of HTTPS (`git@github.com:user/project.git`).
 77+
 78+  _NOTE: it's incompatible with setting the `REPO` variable. This setting will take precedence._
 79+
 80+- `BRANCH` (default: `master`): you can use this setting if you want to change the default branch to be
 81+  checked out when cloning the repository. This might be useful for testing a Pull Request, or if you
 82+  want to use a branch other than `master`.
 83+
 84+For example:
 85+
 86+```shell
 87+REPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh
 88 ```
 89 
 90 #### Manual Installation
 91@@ -161,9 +211,10 @@ cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc
 92 ##### 4. Change your default shell
 93 
 94 ```shell
 95-chsh -s /bin/zsh
 96+chsh -s $(which zsh)
 97 ```
 98-You must log out and log back in to see this change.
 99+
100+You must log out from your user session and log back in to see this change.
101 
102 ##### 5. Initialize your new zsh configuration
103 
104@@ -173,8 +224,10 @@ Once you open up a new terminal window, it should load zsh with Oh My Zsh's conf