From ab874492864f6f649f0ee840982db80fe150a3ff Mon Sep 17 00:00:00 2001 From: Jorge Bucaran Date: Sat, 23 Apr 2016 15:33:09 +0900 Subject: [PATCH] Don't force fisherman down your throat. Remove ``Why fisherman?`` from FAQ. It adds little value since the README is already very clear about what are fisherman's pros. --- README.md | 32 +++++++++----------------------- docs/es-ES/README.md | 2 +- docs/jp-JA/README.md | 30 +++++++++--------------------- docs/zh-CN/README.md | 30 ++++++++---------------------- fisher.fish | 2 +- 5 files changed, 28 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 40efe67..751dfbb 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ # [fisherman] - fish shell plugin manager -fisherman is a zero-configuration, concurrent plugin manager for the [fish shell]. +fisherman is a concurrent plugin manager for the [fish shell]. Read this document in another language: [Español], [日本語], [简体中文]. @@ -160,21 +160,7 @@ fisher self-uninstall Yes. -### 5. Why fisherman? Why not ____? - -fisherman has / is: - -* small and fits in one file - -* zero impact on shell startup time - -* fast and easy to install, update and uninstall - -* no need to edit your fish configuration - -* correct usage of the XDG base directory spec - -### 6. Where does fisherman put stuff? +### 5. Where does fisherman put stuff? fisherman goes in `~/.config/fish/functions/fisher.fish`. @@ -182,7 +168,7 @@ The cache and plugin configuration is created in `~/.cache/fisherman` and `~/.co The fishfile is saved to `~/.config/fish/fishfile`. -### 7. What is a fishfile and how do I use it? +### 6. What is a fishfile and how do I use it? The fishfile `~/.config/fish/fishfile` lists all the installed plugins. @@ -197,15 +183,15 @@ omf/grc This mechanism only installs plugins and missing dependencies. To remove a plugin, use `fisher rm` instead. -### 8. Where can I find a list of fish plugins? +### 7. Where can I find a list of fish plugins? Browse the [organization] or use the [online] search to discover content. -### 9. How do I upgrade from ____? +### 8. How do I upgrade from ____? fisherman does not interfere with any known frameworks. If you want to uninstall oh my fish, refer to their documentation. -### 10. What is a plugin? +### 9. What is a plugin? A plugin is: @@ -215,7 +201,7 @@ A plugin is: 3. a snippet, i.e, one or more `.fish` files inside a directory named `conf.d` that are evaluated by fish at the start of the shell -### 11. How can I list plugins as dependencies to my plugin? +### 10. How can I list plugins as dependencies to my plugin? Create a new `fishfile` file at the root level of your project and write in the plugin dependencies. @@ -225,11 +211,11 @@ https://github.com/dude/sweet https://gist.github.com/bucaran/c256586044fea832e62f02bc6f6daf32 ``` -### 12. What about fundle? +### 11. What about fundle? fundle inspired me to use a bundle file, but it still has limited capabilities and requires you to modify your fish configuration. -### 13. I have a question or request not addressed here. Where should I put it? +### 12. I have a question or request not addressed here. Where should I put it? Create a new ticket on the issue tracker: diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index b588c71..8b365e4 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -17,7 +17,7 @@ # [fisherman] - fish shell plugin manager -fisherman es un gestionador de paquetes para el [fish shell] de procesamiento en paralelo libre de configuración. +fisherman es un gestionador de paquetes para el [fish shell] de procesamiento en paralelo. Lee este documento en otro idioma: [English], [日本語], [简体中文]. diff --git a/docs/jp-JA/README.md b/docs/jp-JA/README.md index 7d22ba0..604d9be 100644 --- a/docs/jp-JA/README.md +++ b/docs/jp-JA/README.md @@ -17,7 +17,7 @@ # [fisherman] - fish shell plugin manager -fishermanとは、フィッシュシェルのための並列処理パッケージマネージャーである。fishermanには設定は必要ではない。 +fishermanとは、フィッシュシェルのための並列処理パッケージマネージャーである。 翻訳: [English], [Español], [简体中文]. @@ -160,19 +160,7 @@ fisher self-uninstall 対応です。 -### 5. なぜfisherman? - -* 小さくて一つのファイルでOK - -* フィッシュシェルのスタート時間に関係ない - -* インストールも、アップグレードも、削除も簡単で、素早い - -* フィッシュシェルの設定に関係ない - -* XDGディレクトリ方針を従う - -### 6. fishermanのファイル等は、どこに保存されますか？ +### 5. fishermanのファイル等は、どこに保存されますか？ fisherman自体は`~/.config/fish/functions/fisher.fish`に。 @@ -180,7 +168,7 @@ fisherman自体は`~/.config/fish/functions/fisher.fish`に。 fishfileは`~/.config/fish/fishfile`に。 -### 7. fishfileとは？ +### 6. fishfileとは？ fishfile（`~/.config/fish/fishfile`）に現在インストールされているプラグインを記入してあります。 @@ -196,15 +184,15 @@ omf/grc この仕組はプラグインと、そのプラグインのデペンデンシーをインストールすることができます。プラグインを削除するために、`fisher rm`を使ってください。 -### 8. フィッシュシェルのプラグインはどこにありますか？ +### 7. フィッシュシェルのプラグインはどこにありますか？ fishermanの[organization]や、[ウェブサイト]等で、プラグインを検索できます。 -### 9. 他のシステムからのアップグレード方法とは？ +### 8. 他のシステムからのアップグレード方法とは？ fishermanは他のフィッシュシェルフレームワーク等に関係ないです。もし、oh-my-fish等をアンインストールしたい場合、あちらのドキュメンテーションを参考してください。 -### 10. プラグインとは？ +### 9. プラグインとは？ プラグインとは @@ -214,7 +202,7 @@ fishermanは他のフィッシュシェルフレームワーク等に関係な 3. スニペット。つまり、1以上の`.fish`ファイルを`conf.d`といディレクトリに。こちらのファイルがフィッシュシェルがスタートする際に実行されます。 -### 11. 自分のプラグインを、他のプラグインのデペンデンシーにしたい場合は？ +### 10. 自分のプラグインを、他のプラグインのデペンデンシーにしたい場合は？ プラグインのrootディレクトリに`fishfile`編集して、そのプラグインを打ってください。 @@ -224,11 +212,11 @@ https://github.com/dude/sweet https://gist.github.com/bucaran/c256586044fea832e62f02bc6f6daf32 ``` -### 12. fundleはどう？ +### 11. fundleはどう？ fundleを参考しながら、vundleのようにfishfileを使いたいと思いましたが、fundle自体はまだ特徴はすくないですし、フィッシュシェルの設定をいじることは必要です。 -### 13. 質問がありますが、どこに書いたらいいですか？ +### 12. 質問がありますが、どこに書いたらいいですか？ 新しいissueを作って頂いて、英語でも、日本語でも対応しております。 diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 9790063..b60408a 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -161,27 +161,13 @@ fisher self-uninstall 是的。 -### 5. 为什么选择 fisherman？ - -fisherman 有以下特色： - -* 小巧，所有代码都在一个文件 - -* 不影响 shell 启动速度 - -* 容易安装、更新和卸载 - -* 你不再需要配置你的 fish 配置 - -* 符合 [XDG](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) 规范 - -### 6. fisherman 把数据放到哪里了？ +### 5. fisherman 把数据放到哪里了？ fisherman 的位置在 `~/.config/fish/functions/fisher.fish`。 缓存和插件配置被分别存在 `~/.cache/fisherman` 和 `~/.config/fisherman`。 fishfile 位置在 `~/.config/fish/fishfile`。 -### 7. 什么是 fishfile 以及如何使用它？ +### 6. 什么是 fishfile 以及如何使用它？ fishfile `~/.config/fish/fishfile` 列出了所有已安装的插件。 @@ -196,15 +182,15 @@ omf/grc 这个文件只会记录插件和一些依赖。如果你想卸载插件，可以使用 `fisher rm`来替代。 -### 8. 去哪里可以找到插件？ +### 7. 去哪里可以找到插件？ 看看这个 [organization] 或者使用这个 [online] 来搜索。 -### 9. 如何从 ____ 更新？ +### 8. 如何从 ____ 更新？ fisherman 没有引入其他任何已知的框架。如果你想卸载 oh my fish, 看它的文档即可 -### 10. 什么是一个插件？ +### 9. 什么是一个插件？ 一个插件是： @@ -214,7 +200,7 @@ fisherman 没有引入其他任何已知的框架。如果你想卸载 oh my fis 3. 一些代码片段，比如一个或多个在 `conf.d`目录下的 `.fish` 文件并且它们会在 shell 启动时执行。 -### 11. 如何把这些插件作为我自己插件的依赖？ +### 10. 如何把这些插件作为我自己插件的依赖？ 在项目的顶层目录创建一个新的 `fishfile` 文件，并写下你的依赖。 @@ -224,11 +210,11 @@ https://github.com/dude/sweet https://gist.github.com/bucaran/c256586044fea832e62f02bc6f6daf32 ``` -### 12. 什么是 fundle? +### 11. 什么是 fundle? fundle 启发我去使用打包的文件，但是目前它仍然有着一些功能限制，需要你去调整 fish 配置。 -### 13. 我有一些问题想提交？ +### 12. 我有一些问题想提交？ 在 gituhb issue 上创建一个新的工单： diff --git a/fisher.fish b/fisher.fish index 5ceaaa1..647531d 100644 --- a/fisher.fish +++ b/fisher.fish @@ -1535,7 +1535,7 @@ function __fisher_man_page_write # where \fIcommand\fR can be one of: \fBi\fRnstall, \fBu\fRpdate, \fBls\fR, \fBrm\fR and \fBh\fRelp # . # .SH "DESCRIPTION" - # fisherman is a zero\-configuration, concurrent plugin manager for the fish shell\. + # fisherman is a plugin manager for the fish shell\. # . # .SH "USAGE" # Install a plugin\.