mj / zsh-config

Download as
Browse Code »

Commit c40e982322217af818963445b71f13a786805de9

Authored by Shrikant Sharat
1 parent ac6ddd7d48

Alpha → Beta.

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