Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README with some example install instructions. Closes #6

  • Loading branch information...
commit 350e39c45f3d77b8c305211992b85c63a17d0dfe 1 parent 3b1bbfc
@qrush qrush authored
Showing with 20 additions and 1 deletion.
  1. +20 −1 README.md
View
21 README.md
@@ -161,7 +161,26 @@ Clone this repo:
cd [name of your sub]
./prepare.sh [name of your sub]
-The prepare script will run you through the steps for making your own sub.
+The prepare script will run you through the steps for making your own sub. Also, don't call it `sub`, by the way! Give it a better name.
+
+## Install your sub
+
+So you've prepared your own sub, now how do you use it? Here's one way you could install your sub in your `$HOME` directory:
+
+ cd
+ git clone [YOUR GIT HOST URL]/sub.git .sub
+
+For bash users:
+
+ echo 'eval "$($HOME/.sub/bin/sub init -)"' >> ~/.bash_profile
+ exec bash
+
+For zsh users:
+
+ echo 'eval "$($HOME/.sub/bin/sub init -)"' >> ~/.zshenv
+ source ~/.zshenv
+
+You could also install your sub in a different directory, say `/usr/local`. This is just one way you could provide a way to install your sub.
## License
Please sign in to comment.
Something went wrong with that request. Please try again.