分发

目前为止,你已经拥有了足够的技术来创建一个有用的 Vim 插件了。 本章节会教你把插件放在网上并使它们易于使用,以及如何对潜在用户进行宣传。

托管

你需要做的第一件事就是把你的插件放到网上,这样其他人才能下载它。 目前 Vim 插件的权威地址是 Vim 网站中的脚本板块

你需要有一个网站中的免费账号。一旦有了,就可以点击“添加脚本”的链接,然后填好表单。 这些应该是一目了然的。

但在最近几年中,一个新的趋势就是把插件仓库托管到一个公开的地方,例如 Bitbucket 或 GitHub。 这种方式的普及可能要归结于两个因素。 首先,Pathogen 的出现使得在各自目录中维护已安装的插件代码变得轻松。 另外,像 Mercurial 和 Git 这样的分布式版本控制系统和像 Bitbucket 和 GitHub 这样的公开托管网站的崛起也起了很大的影响。

对于把自己的配置文件放在版本控制中的人来说把代码仓库提供出来是很方便的。 Mercurial 用户可以用 Mercurial 的“子仓库”功能来保持关注插件的版本, 而 Git 用户可以用子模块功能(但只能用于其他的 Git 仓库,而不像 Mercurial 的子仓库功能)。

保留每个已安装插件的完整仓库也能让你在它们出问题的时候方便调试。 你可以用文件标注(blame),二分查找(bisection),以及任何版本控制系统提供的工具来找出哪里出问题了。 而且如果把仓库留在了电脑中,也能便于你回馈修复漏洞的代码。

希望我已经说服你也应该使自己的插件仓库公开可用。 使用了哪种服务并不重要,只要仓库在某处可用就行了。

文档

虽然你已经为自己的插件编写过全面的 Vim 内部帮助文档,但工作远没有全部完成。 你仍然需要提供一个快速预览来概述一些事:

  1. 你的插件主要涉及什么方面?
  2. 用户为什么会想使用它?
  3. 它为什么比别的竞品好(如果有的话)?
  4. 它使用的是什么许可?
  5. 一个指向精美、完整文档的链接,该文档应该在 vim-doc 网站中渲染过。

这些应该放在 README 文件中(它会显示在 Bitbucket 和 GitHub 仓库中的落地页中), 而且也可以作为 vim.org 中插件入口的描述。

包含一些截图通常都是个不错的主意。 Vim 虽然作为一个纯文本编辑器,但并不表示它不能拥有用户界面。

宣传

一旦你把自己的插件安放到了各种网站中:那就告诉所有人吧! 你可以在 Twitter 上告诉所有的粉丝,在 Reddit 的 /r/vim 板块发帖, 在个人网站上发布一篇博客,以及在 Vim 邮件列表 中宣告,而这些只是开始。

只要你公开发布了一个作品,就会收到一些赞美和批评。不要让负面评论影响你太多。 看看他们都说了什么,但脸皮要厚,当他人指出你工作中的瑕疵(合理的或者不合理的),也不要太情绪化。 没有谁是完美的,而这就是互联网,所以,如果想要维持开心和积极性,就要保持热情,并不要去理会这些。

练习

如果还没有 vim.org 的账号,去创建一个。

查看你最喜欢的一些插件中的 README 文件,看看它们是如何组织的,以及它们包含了些什么种类的信息。

原文地址:http://learnvimscriptthehardway.stevelosh.com/chapters/55.html