From e97773908d44328d6092f749c98ae65bd2b7e214 Mon Sep 17 00:00:00 2001 From: Shrikant Sharat Date: Fri, 27 Jul 2012 15:46:15 +0530 Subject: [PATCH] Added docs on using local paths with -bundle. --- README.mkd | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.mkd b/README.mkd index 3205c78..a8116d7 100644 --- a/README.mkd +++ b/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 -- 2.0.0