Skip to content

Commit

Permalink
Add FAQ in README.md
Browse files Browse the repository at this point in the history
This closes #4 and relates to #3
  • Loading branch information
Tarrasch committed Jun 22, 2014
1 parent feb9771 commit d344d1d
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,50 @@ repositories in `~/.antigen-hs/repos` manually yourself!
[antigen]: https://github.com/zsh-users/antigen
[Shelly]: https://github.com/yesodweb/Shelly.hs
[diff]: https://github.com/Tarrasch/dotfiles/commit/00c3b34c1e1e13d9b0f634611e5bdb5e42211b22

## FAQ

**Is Prezto or oh-my-zsh supported in some way?** No, if you load them they
will be treated like any other plugin. Remember that those two basically are
just bundles of plugins, I recommend against using them because one should load
the individual plugins through a plugin manager like antigen or antigen-hs.
If there's anything inside those plugins that you want, just create a seperate
repository for it [like I did][command-not-found].


**Why do I get `No *.plugin.zsh file` error?** Because all zsh plugins
should have that file. I want to enforce it so that people start following this convention.
The easiest way is to just
[fork the plugin you want](https://github.com/Tarrasch/pure/) and/or
[make them change it](https://github.com/sindresorhus/pure/pull/73)
If you're interested in some discussion about this, take a look at
<https://github.com/Tarrasch/antigen-hs/issues/3> and
<https://github.com/zsh-users/antigen/issues/23>.

**What is the relationship of antigen-hs with antigen?** antigen-hs can achieve
100% of antigen if the user is just willing to spend some time doing things
right (like not using plugin bundles like oh-my-zsh). In reward they don't need
to use software that is bloated. To be fair, many (including my good github
friend @sharat87) might want to say that antigen is more featureful/convenient,
not bloated. I'll let you choose side yourself. :)

**What about the antigen commands like `theme` and others?** I do not found
them useful or stable so I rather not have them. I rather rely on my own zsh fu
when it comes to choirs like updating the repositories (nuking the
`~/.antigen-hs` folder) than relying on some shaky commands of antigen.

**Can I only source GitHub repositories?** At the moment yes, patches are very welcome! :)

**Why not write it in pure zsh?**
[Trust](https://github.com/Tarrasch/zsh-bd)
[me](https://github.com/Tarrasch/zsh-autoenv)
, [it](https://github.com/Tarrasch/zsh-mcd)
[is](https://github.com/Tarrasch/zsh-colors)
[a](https://github.com/Tarrasch/zsh-i-know)
[horrible](https://github.com/Tarrasch/zsh-command-not-found)
[language](https://github.com/Tarrasch/zsh-functional).

**Why Haskell?** I love it, and I found the Shelly plugin to work extremely
well for this kind of tasks.

[command-not-found]: https://github.com/Tarrasch/zsh-command-not-found

0 comments on commit d344d1d

Please sign in to comment.