Added docs on using local paths with -bundle.

Shrikant Sharat
1 parent 0ba48e0fca
Showing 1 changed file with 13 additions and 0 deletions Side-by-side Diff
README.mkd
@@ -199,6 +199,12 @@ specified. The following is perfectly valid.
  
     antigen-bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh
  
+You can also specify a local directory on your file system as a bundle. In this
+case, make sure the path you give is the absolute path (i.e., starts with a
+`/`). Relative paths are not supported. If the repo you gave is a local
+directory path, then it is not necessary that this path is a git repo. Please
+refer to the notes on `--no-local-repo` below.
+
 In addition to the above discussed arguments, `antigen-bundle` also takes a
 `btype` keyword-only argument, that is used internally. You shouldn't be
 concerned with this argument, its only used internally and will probably go away
@@ -235,6 +241,13 @@ creating a clone. For example,
 Note that if the repo url is *not* an absolute local path, this argument has no
 effect.
  
+Also, if the local path given as the url is not a git repo, then this
+argument is forced as it doesn't makes sense to *clone* something that's not a
+git repo. This property can be used to load any utility scripts you have in your
+dotfiles repo. For example,
+
+    antigen-bundle $HOME/dotfiles/oh-my-zsh/custom
+
 ### antigen-bundles
  
 If you have a fair number of bundles, using the `antigen-bundle` command can
...	...	@@ -199,6 +199,12 @@ specified. The following is perfectly valid.
199	199
200	200	antigen-bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh
201	201
	202	+You can also specify a local directory on your file system as a bundle. In this
	203	+case, make sure the path you give is the absolute path (i.e., starts with a
	204	+`/`). Relative paths are not supported. If the repo you gave is a local
	205	+directory path, then it is not necessary that this path is a git repo. Please
	206	+refer to the notes on `--no-local-repo` below.
	207	+
202	208	In addition to the above discussed arguments, `antigen-bundle` also takes a
203	209	`btype` keyword-only argument, that is used internally. You shouldn't be
204	210	concerned with this argument, its only used internally and will probably go away
...	...	@@ -235,6 +241,13 @@ creating a clone. For example,
235	241	Note that if the repo url is not an absolute local path, this argument has no
236	242	effect.
237	243
	244	+Also, if the local path given as the url is not a git repo, then this
	245	+argument is forced as it doesn't makes sense to clone something that's not a
	246	+git repo. This property can be used to load any utility scripts you have in your
	247	+dotfiles repo. For example,
	248	+
	249	+ antigen-bundle $HOME/dotfiles/oh-my-zsh/custom
	250	+
238	251	### antigen-bundles
239	252
240	253	If you have a fair number of bundles, using the `antigen-bundle` command can