mj / zsh-config

Download as
Browse Code ยป

Commit b36de9bb3de2de5ba3f96a54c3dd8f1d070da139

Authored by Shrikant Sharat
1 parent 17f8e971e3

Add links in README and start plugin docs.

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