mj / zsh-config

Download as
Browse Code ยป

Commit e7bf36002c4ec6fa3a8819677605fd45f6dbc784

Authored by Shrikant Sharat
1 parent 4129490cef

Formatting in README.

Showing 1 changed file with 1 additions and 1 deletions Inline Diff

1 # Antigen 1 # Antigen
2 2
3 Antigen is a small set of functions that help you easily manage your shell (zsh) 3 Antigen is a small set of functions that help you easily manage your shell (zsh)
4 plugins, called bundles. The concept is pretty much the same as bundles in a 4 plugins, called bundles. The concept is pretty much the same as bundles in a
5 typical vim+pathogen setup. Antigen is to zsh, what [Vundle][] is to vim. 5 typical vim+pathogen setup. Antigen is to zsh, what [Vundle][] is to vim.
6 6
7 Please note that this is a very new project and can be considered beta at best. 7 Please note that this is a very new project and can be considered beta at best.
8 That said, I am using antigen full time now on my work machine. Also, please 8 That said, I am using antigen full time now on my work machine. Also, please
9 read the commit comments of the changesets when you pull a new version of 9 read the commit comments of the changesets when you pull a new version of
10 antigen. 10 antigen.
11 11
12 ## Show off 12 ## Show off
13 13
14 > Enough talk. Let's fight! 14 > Enough talk. Let's fight!
15 > -- Po, Kung-fu Panda. 15 > -- Po, Kung-fu Panda.
16 16
17 You're going to experience antigen right in your open shell. No `.zshrc` 17 You're going to experience antigen right in your open shell. No `.zshrc`
18 tweaking and reading the rest of this documentation. Kinda like an ice-cream 18 tweaking and reading the rest of this documentation. Kinda like an ice-cream
19 sample, if you will. 19 sample, if you will.
20 20
21 Get and load antigen. 21 Get and load antigen.
22 22
23 curl https://raw.github.com/zsh-users/antigen/master/antigen.zsh > antigen.zsh 23 curl https://raw.github.com/zsh-users/antigen/master/antigen.zsh > antigen.zsh
24 source antigen.zsh 24 source antigen.zsh
25 25
26 There. You now have all the antigen goodies. Let's try install some plugins. How 26 There. You now have all the antigen goodies. Let's try install some plugins. How
27 about some color to start with. Get the [syntax highlighting plugin][] by 27 about some color to start with. Get the [syntax highlighting plugin][] by
28 running 28 running
29 29
30 antigen-bundle zsh-users/zsh-syntax-highlighting 30 antigen-bundle zsh-users/zsh-syntax-highlighting
31 31
32 Now let it do its thing and once its done and you're back at your prompt, try 32 Now let it do its thing and once its done and you're back at your prompt, try
33 and type a command. See that? Colors! 33 and type a command. See that? Colors!
34 34
35 So, you do git? ruby? git and ruby? There are lots of awesome plugins over at 35 So, you do git? ruby? git and ruby? There are lots of awesome plugins over at
36 oh-my-zsh. Treat yourself to some. 36 oh-my-zsh. Treat yourself to some.
37 37
38 antigen-bundle robbyrussell/oh-my-zsh plugins/ruby 38 antigen-bundle robbyrussell/oh-my-zsh plugins/ruby
39 antigen-bundle robbyrussell/oh-my-zsh plugins/git 39 antigen-bundle robbyrussell/oh-my-zsh plugins/git
40 40
41 There are lots of plugins out there in the wild and people are writing zsh 41 There are lots of plugins out there in the wild and people are writing zsh
42 utilities as small scripts all the time. Antigen is compatible with all of them. 42 utilities as small scripts all the time. Antigen is compatible with all of them.
43 The plugins and scripts don't need any special handling to be compatible with 43 The plugins and scripts don't need any special handling to be compatible with
44 antigen. 44 antigen.
45 45
46 The side effect of this is that you can tell antigen to grab just about anything 46 The side effect of this is that you can tell antigen to grab just about anything
47 from anyone's `dotfiles` repo, as long as it is in a directory under any repo on 47 from anyone's `dotfiles` repo, as long as it is in a directory under any repo on
48 github. 48 github.
49 49
50 And themes? How would you like a fancy new prompt for yourself? 50 And themes? How would you like a fancy new prompt for yourself?
51 51
52 antigen-theme funky 52 antigen-theme funky
53 53
54 No? Not your taste? There are many themes available to you, check out the 54 No? Not your taste? There are many themes available to you, check out the
55 oh-my-zsh's [page on themes][]. (You can currently only install themes from 55 oh-my-zsh's [page on themes][]. (You can currently only install themes from
56 robbyrussell's, i.e., the canonical oh-my-zsh repo). 56 robbyrussell's, i.e., the canonical oh-my-zsh repo).
57 57
58 Note: Many of those plugins and especially themes, assume you have the core 58 Note: Many of those plugins and especially themes, assume you have the core
59 library of oh-my-zsh loaded. So, if you want to experiment further, issue a 59 library of oh-my-zsh loaded. So, if you want to experiment further, issue a
60 60
61 antigen-lib 61 antigen-lib
62 62
63 and continue until you're tired. At which point you can come back to this page 63 and continue until you're tired. At which point you can come back to this page
64 ;) 64 ;)
65 65
66 ## Usage 66 ## Usage
67 67
68 So, now that you're here, I'll assume you are convinced and want antigen running 68 So, now that you're here, I'll assume you are convinced and want antigen running
69 your shell all the time. Sweet. Let's do it. 69 your shell all the time. Sweet. Let's do it.
70 70
71 First, clone this repo, probably as a submodule if you have your dotfiles in a 71 First, clone this repo, probably as a submodule if you have your dotfiles in a
72 git repo, 72 git repo,
73 73
74 git clone https://github.com/sharat87/antigen.git 74 git clone https://github.com/sharat87/antigen.git
75 75
76 The usage should be very familiar to you if you use Vundle. A typical `.zshrc` 76 The usage should be very familiar to you if you use Vundle. A typical `.zshrc`
77 might look like this 77 might look like this
78 78
79 source /path-to-antigen-clone/antigen.zsh 79 source /path-to-antigen-clone/antigen.zsh
80 80
81 # Load the oh-my-zsh's library. 81 # Load the oh-my-zsh's library.
82 antigen-lib 82 antigen-lib
83 83
84 # Bundles from the default repo (robbyrussell's oh-my-zsh). 84 # Bundles from the default repo (robbyrussell's oh-my-zsh).
85 antigen-bundle git 85 antigen-bundle git
86 antigen-bundle heroku 86 antigen-bundle heroku
87 antigen-bundle pip 87 antigen-bundle pip
88 antigen-bundle lein 88 antigen-bundle lein
89 antigen-bundle command-not-found 89 antigen-bundle command-not-found
90 90
91 # Syntax highlighting bundle. 91 # Syntax highlighting bundle.
92 antigen-bundle zsh-users/zsh-syntax-highlighting 92 antigen-bundle zsh-users/zsh-syntax-highlighting
93 93
94 # Load the theme. 94 # Load the theme.
95 antigen-theme robbyrussell 95 antigen-theme robbyrussell
96 96
97 # Tell antigen that you're done. 97 # Tell antigen that you're done.
98 antigen-apply 98 antigen-apply
99 99
100 Open your zsh with this zshrc and you should see all the bundles you defined 100 Open your zsh with this zshrc and you should see all the bundles you defined
101 here, getting installed. Once its done, you are ready to roll. The complete 101 here, getting installed. Once its done, you are ready to roll. The complete
102 syntax for the `antigen-bundle` command is discussed further down on this page. 102 syntax for the `antigen-bundle` command is discussed further down on this page.
103 103
104 ## Motivation 104 ## Motivation
105 105
106 If you use zsh and [oh-my-zsh][], you know that having many different plugins 106 If you use zsh and [oh-my-zsh][], you know that having many different plugins
107 that are developed by many different authors in a single (sub)repo is not a very 107 that are developed by many different authors in a single (sub)repo is not a very
108 easy to maintain. There are some really fantastic plugins and utilities in 108 easy to maintain. There are some really fantastic plugins and utilities in
109 oh-my-zsh, but having them all in a single repo doesn't really scale well. And I 109 oh-my-zsh, but having them all in a single repo doesn't really scale well. And I
110 admire robbyrussell's efforts for reviewing and merging the gigantic number of 110 admire robbyrussell's efforts for reviewing and merging the gigantic number of
111 pull requests the project gets. It needs a better way of plugin management. 111 pull requests the project gets. It needs a better way of plugin management.
112 112
113 This was discussed on [a][1] [few][2] [issues][3], but it doesn't look like 113 This was discussed on [a][1] [few][2] [issues][3], but it doesn't look like
114 there was any progress made. So, I'm trying to start this off with antigen, 114 there was any progress made. So, I'm trying to start this off with antigen,
115 hoping to better this situation. Please note that I'm by no means a zsh or any 115 hoping to better this situation. Please note that I'm by no means a zsh or any
116 shell script expert (far from it). 116 shell script expert (far from it).
117 117
118 [1]: https://github.com/robbyrussell/oh-my-zsh/issues/465 118 [1]: https://github.com/robbyrussell/oh-my-zsh/issues/465
119 [2]: https://github.com/robbyrussell/oh-my-zsh/issues/377 119 [2]: https://github.com/robbyrussell/oh-my-zsh/issues/377
120 [3]: https://github.com/robbyrussell/oh-my-zsh/issues/1014 120 [3]: https://github.com/robbyrussell/oh-my-zsh/issues/1014
121 121
122 Inspired by vundle, antigen can pull oh-my-zsh style plugins from various github 122 Inspired by vundle, antigen can pull oh-my-zsh style plugins from various github
123 repositories. You are not limited to use plugins from the oh-my-zsh repository 123 repositories. You are not limited to use plugins from the oh-my-zsh repository
124 only and you don't need to maintain your own fork and pull from upstream every 124 only and you don't need to maintain your own fork and pull from upstream every
125 now and then. 125 now and then.
126 126
127 Antigen also lets you switch the prompt theme with one command, just like that 127 Antigen also lets you switch the prompt theme with one command, just like that
128 128
129 bundle-theme candy 129 bundle-theme candy
130 130
131 and your prompt is changed, just for this session of course. 131 and your prompt is changed, just for this session of course.
132 132
133 ## Commands 133 ## Commands
134 134
135 ### antigen-bundle 135 ### antigen-bundle
136 136
137 This command tells antigen to install (if not already installed) and load the 137 This command tells antigen to install (if not already installed) and load the
138 given plugin. The simplest usage follows the following syntax. 138 given plugin. The simplest usage follows the following syntax.
139 139
140 antigen-bundle <plugin-name> 140 antigen-bundle <plugin-name>
141 141
142 This will install the `plugins/<name>` directory from [robbyrussell's 142 This will install the `plugins/<name>` directory from [robbyrussell's
143 oh-my-zsh][oh-my-zsh] (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`). 143 oh-my-zsh][oh-my-zsh] (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`).
144 144
145 However, the above is just syntax sugar for the extended syntax of the 145 However, the above is just syntax sugar for the extended syntax of the
146 `antigen-bundle` command. 146 `antigen-bundle` command.
147 147
148 antigen-bundle [<url> [<loc>]] 148 antigen-bundle [<url> [<loc>]]
149 149
150 where `<url>` is the repository url and it defaults to [robbyrussell's 150 where `<url>` is the repository url and it defaults to [robbyrussell's
151 oh-my-zsh][oh-my-zsh] repo (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL` 151 oh-my-zsh][oh-my-zsh] repo (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`
152 discussed further down). `<loc>` is the path under this repository which has the 152 discussed further down). `<loc>` is the path under this repository which has the
153 zsh plugin. This is typically the directory that contains a `*.plugin.zsh` file, 153 zsh plugin. This is typically the directory that contains a `*.plugin.zsh` file,
154 but it could contain a completion file or just many `*.zsh` files to be sourced. 154 but it could contain a completion file or just many `*.zsh` files to be sourced.
155 `<loc>` defaults to `/`, which indicates the repository itself is a plugin. 155 `<loc>` defaults to `/`, which indicates the repository itself is a plugin.
156 156
157 An example invocation would be 157 An example invocation would be
158 158
159 # The following is the same as `antigen-bundle ant`. But for demonstration 159 # The following is the same as `antigen-bundle ant`. But for demonstration
160 # purposes, we use the extended syntax here. 160 # purposes, we use the extended syntax here.
161 antigen-bundle https://github.com/robbyrussell/oh-my-zsh.git plugins/ant 161 antigen-bundle https://github.com/robbyrussell/oh-my-zsh.git plugins/ant
162 162
163 This would install the ant plugin from robbyrussell's oh-my-zsh repo. Of course, 163 This would install the ant plugin from robbyrussell's oh-my-zsh repo. Of course,
164 github url's can be shortened. 164 github url's can be shortened.
165 165
166 antigen-bundle robbyrussell/oh-my-zsh plugins/ant 166 antigen-bundle robbyrussell/oh-my-zsh plugins/ant
167 167
168 And since this repo is the default, even that isn't necessary. But we can't 168 And since this repo is the default, even that isn't necessary. But we can't
169 specify the `loc` without giving the first argument. 169 specify the `loc` without giving the first argument.
170 170
171 For this and a few other reasons, `antigen-bundle` also supports a simple 171 For this and a few other reasons, `antigen-bundle` also supports a simple
172 keyword argument syntax, using which we can rewrite the above as 172 keyword argument syntax, using which we can rewrite the above as
173 173
174 antigen-bundle --loc=plugins/ant 174 antigen-bundle --loc=plugins/ant
175 175
176 Which picks up the default for the `url` argument, and uses the `loc` given to 176 Which picks up the default for the `url` argument, and uses the `loc` given to
177 it. 177 it.
178 178
179 *Note* that you can mix and match positional and keyword arguments. But you 179 *Note* that you can mix and match positional and keyword arguments. But you
180 can't have positional arguments after keyword arguments. 180 can't have positional arguments after keyword arguments.
181 181
182 antigen-bundle robbyrussell/oh-my-zsh --loc=plugins/ant 182 antigen-bundle robbyrussell/oh-my-zsh --loc=plugins/ant
183 183
184 And keyword arguments don't care about the order in which the arguments are 184 And keyword arguments don't care about the order in which the arguments are
185 specified. The following is perfectly valid. 185 specified. The following is perfectly valid.
186 186
187 antigen-bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh 187 antigen-bundle --loc=plugins/ant --url=robbyrussell/oh-my-zsh
188 188
189 In addition to the above discussed arguments, `antigen-bundle` also takes a 189 In addition to the above discussed arguments, `antigen-bundle` also takes a
190 `btype` keyword-only argument, that is used internally. You shouldn't be 190 `btype` keyword-only argument, that is used internally. You shouldn't be
191 concerned with this argument, its only used internally and will probably go away 191 concerned with this argument, its only used internally and will probably go away
192 in the future. It indicates whether the bundle is a theme or a simple plugin. 192 in the future. It indicates whether the bundle is a theme or a simple plugin.
193 193
194 You can use this `antigen-bundle` command not just from your `.zshrc`, but also 194 You can use this `antigen-bundle` command not just from your `.zshrc`, but also
195 from your shell environment. This allows you to install plugins on the fly and 195 from your shell environment. This allows you to install plugins on the fly and
196 try them out. Of course if you want a bundle to be available every time you open 196 try them out. Of course if you want a bundle to be available every time you open
197 a shell, put it in your `.zshrc`. 197 a shell, put it in your `.zshrc`.
198 198
199 Other keyword-only arguments accepted: 199 Other keyword-only arguments accepted:
200 200
201 --branch &mdash; Specify the branch of the git repo to be used for this bundle. 201 `branch` &mdash; Specify the branch of the git repo to be used for this bundle.
202 Please note that if you specify two plugins to be loaded from the same git repo, 202 Please note that if you specify two plugins to be loaded from the same git repo,
203 but different branches, then two separate clones of this repo will be 203 but different branches, then two separate clones of this repo will be
204 maintained. This is a small implementation detail and shouldn't influence you in 204 maintained. This is a small implementation detail and shouldn't influence you in
205 any way. 205 any way.
206 206
207 ### antigen-bundles 207 ### antigen-bundles
208 208
209 If you have a fair number of bundles, using the `antigen-bundle` command can 209 If you have a fair number of bundles, using the `antigen-bundle` command can
210 look cumbersome. You can use the `antigen-bundles` command to *bulk* define 210 look cumbersome. You can use the `antigen-bundles` command to *bulk* define
211 bundles instead of individual calls to `antigen-bundle`. 211 bundles instead of individual calls to `antigen-bundle`.
212 212
213 Usage is pretty straightforward. Just pipe the bundle specifications, just as 213 Usage is pretty straightforward. Just pipe the bundle specifications, just as
214 you would give to the `antigen-bundle` command, one per line, into the 214 you would give to the `antigen-bundle` command, one per line, into the
215 `antigen-bundles` command. The easiest way to do this, is using the heredoc 215 `antigen-bundles` command. The easiest way to do this, is using the heredoc
216 syntax. 216 syntax.
217 217
218 antigen-bundles <<EOF 218 antigen-bundles <<EOF
219 # Guess what to install when running an unknown command. 219 # Guess what to install when running an unknown command.
220 command-not-found 220 command-not-found
221 221
222 # The heroku tool helper plugin. 222 # The heroku tool helper plugin.
223 heroku 223 heroku
224 224
225 EOF 225 EOF
226 226
227 This is equivalent to 227 This is equivalent to
228 228
229 antigen-bundle command-not-found 229 antigen-bundle command-not-found
230 antigen-bundle heroku 230 antigen-bundle heroku
231 231
232 Of course, as you can see, from the lines piped to `antigen-bundles`, empty 232 Of course, as you can see, from the lines piped to `antigen-bundles`, empty
233 lines and those starting with a `#` are ignored. The rest are passed to 233 lines and those starting with a `#` are ignored. The rest are passed to
234 `antigen-bundle` without any quoting rules applied. They are actually `eval`-ed 234 `antigen-bundle` without any quoting rules applied. They are actually `eval`-ed
235 with the `antigen-bundle` command. See the source if you want to really 235 with the `antigen-bundle` command. See the source if you want to really
236 understand how it works. Its a very small function. 236 understand how it works. Its a very small function.
237 237
238 ### antigen-update 238 ### antigen-update
239 239
240 This is something you might not want to put in your `.zshrc`. Instead, run it 240 This is something you might not want to put in your `.zshrc`. Instead, run it
241 occasionally to update all your plugins. It doesn't take any arguments. 241 occasionally to update all your plugins. It doesn't take any arguments.
242 242
243 antigen-update 243 antigen-update
244 244
245 Please note that the updates that are downloaded are not immediately available. 245 Please note that the updates that are downloaded are not immediately available.
246 You have to open a new shell to be able to see the changes. This is a limitation 246 You have to open a new shell to be able to see the changes. This is a limitation
247 by design since reloading all the plugins *might* have some nasty side effects 247 by design since reloading all the plugins *might* have some nasty side effects
248 that may not be immediately apparent. Let's just say it can make your shell act 248 that may not be immediately apparent. Let's just say it can make your shell act
249 real quirky. 249 real quirky.
250 250
251 **Please note**: This command is not for updating *antigen* itself. Its for 251 **Please note**: This command is not for updating *antigen* itself. Its for
252 updating the bundles you are using with antigen. 252 updating the bundles you are using with antigen.
253 253
254 ### antigen-list 254 ### antigen-list
255 255
256 Use this command to list out the currently *loaded* plugins. Keep in mind that 256 Use this command to list out the currently *loaded* plugins. Keep in mind that
257 this includes any bundles installed on-the-fly. 257 this includes any bundles installed on-the-fly.
258 258
259 Takes no arguments. Gives out the repo url and the plugin's location under the 259 Takes no arguments. Gives out the repo url and the plugin's location under the
260 repo. 260 repo.
261 261
262 ### antigen-cleanup 262 ### antigen-cleanup
263 263
264 Used to clean up the clones of repos which are not used by any plugins. It takes 264 Used to clean up the clones of repos which are not used by any plugins. It takes
265 no arguments. When this is run, it lists out the repo-clones that are available 265 no arguments. When this is run, it lists out the repo-clones that are available
266 but are not used by any plugin *currently loaded*. 266 but are not used by any plugin *currently loaded*.
267 267
268 This command currently cannot run in a non-interactive mode. So it won't be very 268 This command currently cannot run in a non-interactive mode. So it won't be very
269 pleasant to use it in your `.zshrc`. 269 pleasant to use it in your `.zshrc`.
270 270
271 ### antigen-lib 271 ### antigen-lib
272 272
273 This is a shortcut to 273 This is a shortcut to
274 274
275 antigen-bundle --loc=lib 275 antigen-bundle --loc=lib
276 276
277 So, it basically installs the oh-my-zsh's library as a bundle. Please note that 277 So, it basically installs the oh-my-zsh's library as a bundle. Please note that
278 this assumes that the `ANTIGEN_DEFAULT_REPO_URL` is set to the oh-my-zsh repo or 278 this assumes that the `ANTIGEN_DEFAULT_REPO_URL` is set to the oh-my-zsh repo or
279 a fork of that repo. If you want to specify the `url` too, then you can't use 279 a fork of that repo. If you want to specify the `url` too, then you can't use
280 the `antigen-lib` short cut. You have to do that directly with the 280 the `antigen-lib` short cut. You have to do that directly with the
281 `antigen-bundle` command. 281 `antigen-bundle` command.
282 282
283 This is present only for legacy reasons and *might* (or might not) be removed in 283 This is present only for legacy reasons and *might* (or might not) be removed in
284 the future. 284 the future.
285 285
286 Use 286 Use
287 287
288 antigen-lib 288 antigen-lib
289 289
290 in your `.zshrc`, before any `antigen-bundle` declarations. It takes no 290 in your `.zshrc`, before any `antigen-bundle` declarations. It takes no
291 arguments. 291 arguments.
292 292
293 ### antigen-theme 293 ### antigen-theme
294 294
295 Used for switching the prompt theme. Invoke it with the name of the theme you 295 Used for switching the prompt theme. Invoke it with the name of the theme you
296 want to use. 296 want to use.
297 297
298 antigen-theme fox 298 antigen-theme fox
299 299
300 Currently, themes are pulled from robbyrussell's oh-my-zsh repo, but it will 300 Currently, themes are pulled from robbyrussell's oh-my-zsh repo, but it will
301 support getting themes from other repos as well in the future. 301 support getting themes from other repos as well in the future.
302 302
303 You can use this command to change your theme on the fly in your shell. Go on, 303 You can use this command to change your theme on the fly in your shell. Go on,
304 try out a few themes in your shell before you set it in your `.zshrc`. 304 try out a few themes in your shell before you set it in your `.zshrc`.
305 305
306 ### antigen-apply 306 ### antigen-apply
307 307
308 You have to add this command after defining all bundles you need, in your zshrc. 308 You have to add this command after defining all bundles you need, in your zshrc.
309 The completions defined by your bundles will be loaded at this step. 309 The completions defined by your bundles will be loaded at this step.
310 310
311 It is possible to load completions as and when a bundle is specified with the 311 It is possible to load completions as and when a bundle is specified with the
312 bundle command, in which case this command would not be necessary. But loading 312 bundle command, in which case this command would not be necessary. But loading
313 the completions is a time-consuming process and your shell will start noticeably 313 the completions is a time-consuming process and your shell will start noticeably
314 slow if you have a good number of bundle specifications. 314 slow if you have a good number of bundle specifications.
315 315
316 However, if you're a zsh expert and can suggest a way so that this would not be 316 However, if you're a zsh expert and can suggest a way so that this would not be
317 necessary, I am very interested in discussing it. Please open up an issue with 317 necessary, I am very interested in discussing it. Please open up an issue with
318 your details. Thanks. 318 your details. Thanks.
319 319
320 ## Configuration 320 ## Configuration
321 321
322 The following environment variables can be set to customize the behavior of 322 The following environment variables can be set to customize the behavior of
323 antigen. Make sure you set them *before* source-ing `antigen.zsh`. 323 antigen. Make sure you set them *before* source-ing `antigen.zsh`.
324 324
325 `ANTIGEN_DEFAULT_REPO_URL` &mdash; This is the default repository url that is 325 `ANTIGEN_DEFAULT_REPO_URL` &mdash; This is the default repository url that is
326 used for `bundle` commands. The default value is robbyrussell's oh-my-zsh repo, 326 used for `bundle` commands. The default value is robbyrussell's oh-my-zsh repo,
327 but you can set this to the fork url of your own fork. 327 but you can set this to the fork url of your own fork.
328 328
329 `ADOTDIR` &mdash; This directory is used to store all the repo clones, your 329 `ADOTDIR` &mdash; This directory is used to store all the repo clones, your
330 bundles, themes, caches and everything else antigen requires to run smoothly. 330 bundles, themes, caches and everything else antigen requires to run smoothly.
331 Defaults to `$HOME/.antigen`. 331 Defaults to `$HOME/.antigen`.
332 332
333 **Note**: `ANTIGEN_REPO_CACHE` & `ANTIGEN_BUNDLE_DIR` &mdash; These variables 333 **Note**: `ANTIGEN_REPO_CACHE` & `ANTIGEN_BUNDLE_DIR` &mdash; These variables
334 were used previously but are now removed. Please use `ADOTDIR` instead, as 334 were used previously but are now removed. Please use `ADOTDIR` instead, as
335 mentioned above. 335 mentioned above.
336 336
337 ## Notes on writing plugins 337 ## Notes on writing plugins
338 338
339 > *TBD* 339 > *TBD*
340 340
341 ## Meta 341 ## Meta
342 342
343 Project is licensed with the [MIT License][license]. To contribute, just fork, 343 Project is licensed with the [MIT License][license]. To contribute, just fork,
344 make changes and send a pull request. If its a rather long/complicated change, 344 make changes and send a pull request. If its a rather long/complicated change,
345 please consider opening an [issue][] first so we can discuss it out. 345 please consider opening an [issue][] first so we can discuss it out.
346 346
347 Any comments/suggestions/feedback welcome. Please join the discussion on the 347 Any comments/suggestions/feedback welcome. Please join the discussion on the
348 [reddit page][] of this project. Also, follow me on twitter, 348 [reddit page][] of this project. Also, follow me on twitter,
349 [@sharat87](twitter). 349 [@sharat87](twitter).
350 350
351 [Vundle]: https://github.com/gmarik/vundle 351 [Vundle]: https://github.com/gmarik/vundle
352 [page on themes]: https://github.com/robbyrussell/oh-my-zsh/wiki/Themes 352 [page on themes]: https://github.com/robbyrussell/oh-my-zsh/wiki/Themes
353 [syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting 353 [syntax highlighting plugin]: https://github.com/zsh-users/zsh-syntax-highlighting
354 [oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh 354 [oh-my-zsh]: https://github.com/robbyrussell/oh-my-zsh
355 [issue]: https://github.com/sharat87/antigen/issues 355 [issue]: https://github.com/sharat87/antigen/issues
356 [license]: http://mit.sharats.me 356 [license]: http://mit.sharats.me
357 [reddit page]: http://www.reddit.com/r/commandline/comments/u4f26/antigen_a_plugin_manager_for_zsh_shell/ 357 [reddit page]: http://www.reddit.com/r/commandline/comments/u4f26/antigen_a_plugin_manager_for_zsh_shell/
358 [twitter]: http://twitter.com/sharat87 358 [twitter]: http://twitter.com/sharat87
359 359