Merge pull request cli#289 from atomiyama/misc/modify_installation

Nate Smith · web-flow · commit 1b9b76d8fc9e · 2020-02-04T12:14:43.000-06:00
ADD installation from source section to README.
diff --git a/README.md b/README.md
@@ -69,8 +69,9 @@ Install and upgrade:
 
 ### Other platforms
 
-Install a prebuilt binary from the [releases page][] or source compile by running `make` from the
-project directory.
+Install a prebuilt binary from the [releases page][]
+
+### [Build from source](/source.md)
 
 <!-- TODO eventually we'll have https://cli.github.com/manual -->
 [docs]: https://cli.github.io/cli/gh
diff --git a/source.md b/source.md
@@ -0,0 +1,31 @@
+# Installation from source
+
+1. Clone cli into `~/.githubcli`
+```
+$ git clone https://github.com/cli/cli.git ~/.githubcli
+```
+
+2. Compile
+```
+$ cd ~/.githubcli && make
+```
+
+3. Add `~/.githubcli/bin` to your $PATH for access to the gh command-line utility.
+
+  * For **bash**:
+  ~~~ bash
+  $ echo 'export PATH="$HOME/.githubcli/bin:$PATH"' >> ~/.bash_profile
+  ~~~
+  
+  * For **Zsh**:
+  ~~~ zsh
+  $ echo 'export PATH="$HOME/.githubcli/bin:$PATH"' >> ~/.zshrc
+  ~~~
+  
+  * For **Fish shell**:
+  ~~~ fish
+  $ set -Ux fish_user_paths $HOME/.githubcli/bin $fish_user_paths
+  ~~~
+
+4. Restart your shell so that PATH changes take effect.
+
