Mirrors/awesome-zsh-plugins
2
0
Fork 0
mirror of https://github.com/unixorn/awesome-zsh-plugins synced 2024-11-25 10:30:17 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add advise about fpath to Writing_Plugins.md

Browse source 
All files in the fpath directories should be able to be compiled. See
http://zsh.sourceforge.net/Doc/Release/User-Contributions.html#Recompiling-Functions

This allows ZSH to take advantage of compiled function digest files. See
http://zsh.sourceforge.net/Doc/Release/Functions.html#Autoloading-Functions
This commit is contained in:
Eric Nielsen 2019-12-16 19:36:07 -05:00
parent e2cc67da15
commit 88a295aee8
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Writing_Plugins.md
View file

@ -12,6 +12,8 @@ Try and keep your plugins as cross-framework compatible as possible. Here are so
5. If you’re making a theme, please include a screenshot so prospective users can see what it looks like without having to install it.
6. If your plugin adds any of its subdirectories to the `fpath`, make sure those subdirectories only contain function definition files. This allows for frameworks to correctly [zcompile all functions](http://zsh.sourceforge.net/Doc/Release/Functions.html#Autoloading-Functions). Don't make your plugin add its root directory to the `fpath`.
6. Don't forget to add a license. [choosealicense.com](https://choosealicense.com) is a good tool to help you pick one.
7. Submit a PR here so your plugin is easy to find :-)