mj / zsh-config

Download as
Browse Code ยป

Commit b33b9e9d4e80494d11855b8691fdb7e4ed4e3069

Authored by Shrikant Sharat
1 parent 72e72c6085

Fix #24. Add recommendation about plugin structure. 

Adding the oh-my-zsh way of organising plugins as a recommending way of writing
plugins. Though of course, in the spirit of antigen, it is not required.

Showing 1 changed file with 7 additions and 3 deletions Side-by-side Diff

... ... @@ -468,9 +468,13 @@ functionality of antigen.
468 468  
469 469 ## Notes on writing plugins
470 470  
471   -If you are just going to write a single `.sh` file with the goodness you want to
472   -create, just forget about this and go do that. Antigen will work just fine with
473   -such a plugin.
  471 +Most shell utilities/plugins are made up of just one file. For a plugin called
  472 +`awesomeness`, create a `awesomeness.plugin.zsh` and code away.
  473 +
  474 +That said, even if you write a single file as a `.sh` file with the goodness you
  475 +want to create, antigen will work just fine with it. The `*.plugin.zsh` way is
  476 +recommended by antigen, because it is widely used because of the [oh-my-zsh][]
  477 +project.
474 478  
475 479 If you want to know how antigen loads the plugins, do continue.
476 480