From 9047bde4acd66f41c0e544124ee8a89681c87321 Mon Sep 17 00:00:00 2001 From: Jorge Bucaran Date: Sat, 23 Apr 2016 14:23:30 +0900 Subject: [PATCH] Remove fish install instructions from FAQ. It's too difficult to maintain install instructions in the FAQ and possibly out of the scope of the project. Also make it obvious that fisherman is designed for fish >= 2.3.0 and that users using fish 2.2.0 need to add conf.d support to their ~/.config/fish/config.fish for snippet support. --- README.md | 48 ++++++++++++-------------------------------- docs/es-ES/README.md | 48 ++++++++++++-------------------------------- docs/jp-JA/README.md | 48 ++++++++++++-------------------------------- docs/zh-CN/README.md | 46 +++++++++++------------------------------- 4 files changed, 51 insertions(+), 139 deletions(-) diff --git a/README.md b/README.md index 1c49769..ff19aa4 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,7 @@ fisher help z ### 1. What fish version is required? -fisherman was built for the latest fish, but at least 2.2.0 is required. If you can't upgrade your build, append the following code to your `~/.config/fish/config.fish` for [snippet](#12-what-is-a-plugin) support. +fisherman was built for fish >= 2.3.0. If you are using 2.2.0, append the following code to your `~/.config/fish/config.fish` for [snippet](#12-what-is-a-plugin) support. ```fish for file in ~/.config/fish/conf.d/*.fish @@ -139,29 +139,7 @@ for file in ~/.config/fish/conf.d/*.fish end ``` -### 2. How do I install fish on OS X? - -With Homebrew. - -``` -brew install fish -``` - -### 3. How do I install the latest fish on some Linux? - -With git, from the source. - -```sh -sudo apt-get -y install git gettext automake autoconf \ - ncurses-dev build-essential libncurses5-dev - -git clone -q --depth 1 https://github.com/fish-shell/fish-shell -cd fish-shell -autoreconf && ./configure -make && sudo make install -``` - -### 4. How do I use fish as my default shell? +### 2. How do I use fish as my default shell? Add fish to the list of login shells in `/etc/shells` and make it your default shell. @@ -170,7 +148,7 @@ echo "/usr/local/bin/fish" | sudo tee -a /etc/shells chsh -s /usr/local/bin/fish ``` -### 5. How do I uninstall fisherman? +### 3. How do I uninstall fisherman? Run @@ -178,11 +156,11 @@ Run fisher self-uninstall ``` -### 6. Is fisherman compatible with oh my fish themes and plugins? +### 4. Is fisherman compatible with oh my fish themes and plugins? Yes. -### 7. Why fisherman? Why not ____? +### 5. Why fisherman? Why not ____? fisherman has / is: @@ -196,7 +174,7 @@ fisherman has / is: * correct usage of the XDG base directory spec -### 8. Where does fisherman put stuff? +### 6. Where does fisherman put stuff? fisherman goes in `~/.config/fish/functions/fisher.fish`. @@ -204,7 +182,7 @@ The cache and plugin configuration is created in `~/.cache/fisherman` and `~/.co The fishfile is saved to `~/.config/fish/fishfile`. -### 9. What is a fishfile and how do I use it? +### 7. What is a fishfile and how do I use it? The fishfile `~/.config/fish/fishfile` lists all the installed plugins. @@ -219,15 +197,15 @@ omf/grc This mechanism only installs plugins and missing dependencies. To remove a plugin, use `fisher rm` instead. -### 10. Where can I find a list of fish plugins? +### 8. Where can I find a list of fish plugins? Browse the [organization] or use the [online] search to discover content. -### 11. How do I upgrade from ____? +### 9. 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. -### 12. What is a plugin? +### 10. What is a plugin? A plugin is: @@ -237,7 +215,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 -### 13. How can I list plugins as dependencies to my plugin? +### 11. 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. @@ -247,11 +225,11 @@ https://github.com/dude/sweet https://gist.github.com/bucaran/c256586044fea832e62f02bc6f6daf32 ``` -### 14. What about fundle? +### 12. 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. -### 15. I have a question or request not addressed here. Where should I put it? +### 13. 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 9402958..a2c6e0d 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -131,7 +131,7 @@ fisher help z ### 1. ¿Qué versión de fish se requiere? -fisherman está diseñado para el último fish, pero se requiere 2.0.0 mínimo. Si no puedes actualizar fish, añade este código a `~/.config/fish/config.fish` para poder ejecutar [snippets](#13-qué-es-un-paquete). +fisherman fue diseñado para fish >= 2.3.0. Si estás en 2.2.0 y no puedes actualizarte por algún motivo, añade este código a `~/.config/fish/config.fish` para poder ejecutar [snippets](#13-qué-es-un-paquete). ```fish for file in ~/.config/fish/conf.d/*.fish @@ -139,29 +139,7 @@ for file in ~/.config/fish/conf.d/*.fish end ``` -### 2. ¿Cómo puedo instalar fish en OS X? - -Via Homebrew. - -``` -brew install fish -``` - -### 3. ¿Cómo puedo instalar el útlimo fish en algunos Linux? - -Via git, compilando el código. - -```sh -sudo apt-get -y install git gettext automake autoconf \ - ncurses-dev build-essential libncurses5-dev - -git clone -q --depth 1 https://github.com/fish-shell/fish-shell -cd fish-shell -autoreconf && ./configure -make && sudo make install -``` - -### 4. ¿Cómo hago fish mi shell por defecto? +### 2. ¿Cómo hago fish mi shell por defecto? Añade fish a la lista de login shells in `/etc/shells`. @@ -170,7 +148,7 @@ echo "/usr/local/bin/fish" | sudo tee -a /etc/shells chsh -s /usr/local/bin/fish ``` -### 5. ¿Cómo puedo desinstalar fisherman? +### 3. ¿Cómo puedo desinstalar fisherman? Entra @@ -178,11 +156,11 @@ Entra fisher self-uninstall ``` -### 6. ¿Es fisherman compatible con paquetes y temas de oh my fish? +### 4. ¿Es fisherman compatible con paquetes y temas de oh my fish? Sí. -### 7. ¿Por qué fisherman? ¿Por qué no ____? +### 5. ¿Por qué fisherman? ¿Por qué no ____? fisherman tiene / es: @@ -196,7 +174,7 @@ fisherman tiene / es: * Usa el sistema XDG de directions base correctamente -### 8. ¿Dónde guarda fisherman las cosas? +### 6. ¿Dónde guarda fisherman las cosas? fisherman mismo va en `~/.config/fish/functions/fisher.fish`. @@ -204,7 +182,7 @@ El caché y la configuración en `~/.cache/fisherman` y `~/.config/fisherman` re El fishfile en `~/.config/fish/fishfile`. -### 9. ¿Qué es el fishfile y cómo lo uso? +### 7. ¿Qué es el fishfile y cómo lo uso? El fishfile `~/.config/fish/fishfile` registra todos los paquetes que están instalados. @@ -219,15 +197,15 @@ omf/grc Este mecanismo solo instala paquetes y dependecias necesarias. Para remover paquetes, usa `fisher rm`. -### 10. ¿Dónde consigo las lista de paquetes para fish? +### 8. ¿Dónde consigo las lista de paquetes para fish? Diríjete a la [organización] o usa la búsqueda [en línea] para descrubir contenido. -### 11. ¿Cómo puedo migrar desde ____? +### 9. ¿Cómo puedo migrar desde ____? fisherman no interfiere con otros sistemas conocidos. Si quieres desinstalar oh my fish, diríjete a su documentación -### 13. ¿Qué es un paquete? +### 10. ¿Qué es un paquete? Un paquete es: @@ -237,7 +215,7 @@ Un paquete es: 3. un snippet, es decir, uno o más archivos `.fish` en un directorio llamado `conf.d` que son ejecutados por fish al inicio de la sesión. -### 14. ¿Cómo puedo añadir dependencias a mi plugin? +### 11. ¿Cómo puedo añadir dependencias a mi plugin? Crea un `fishfile` en el nivel raíz de tu proyecto y escribe los paquetes. @@ -247,11 +225,11 @@ https://github.com/dude/sweet https://gist.github.com/bucaran/c256586044fea832e62f02bc6f6daf32 ``` -### 15. ¿Qué puedes decir de fundle? +### 12. ¿Qué puedes decir de fundle? fundle fue la inspiración para utilizar el fishfile, pero todavía es limitado en sus capacidades y hace requisito modificar la configuración de fish. -### 16. Tengo una pregunta que no aparece aquí. ¿Dónde pregunto? +### 13. Tengo una pregunta que no aparece aquí. ¿Dónde pregunto? Crea un nuevo ticket en el issue tracker: diff --git a/docs/jp-JA/README.md b/docs/jp-JA/README.md index 51f498c..68d1128 100644 --- a/docs/jp-JA/README.md +++ b/docs/jp-JA/README.md @@ -131,7 +131,7 @@ fisher help z ### 1. fishの必要なバージョンとは？ -fisherman、fishの最新バーションのために、開発していますが、最低バーションは2.2.0です。１番新しいfishのアップグレードが、不可能であれば、[snippets](#13-プラグインとは？)の対応のため、次のコードを`~/.config/fish/config.fish`に書いてください。 +fish >= 2.3.0は必要です。まだ2.2.0を利用中であれば、[snippets](#13-プラグインとは？)の対応のため、次のコードを`~/.config/fish/config.fish`に書いてください。 ```fish for file in ~/.config/fish/conf.d/*.fish @@ -139,29 +139,7 @@ for file in ~/.config/fish/conf.d/*.fish end ``` -### 2. OSXにフィッシュシェルをインストールする方法は？ - -Homebrewで - -``` -brew install fish -``` - -### 3. Linuxにフィッシュシェルをインストールする方法は？ - -gitで、ソースから。 - -```sh -sudo apt-get -y install git gettext automake autoconf \ - ncurses-dev build-essential libncurses5-dev - -git clone -q --depth 1 https://github.com/fish-shell/fish-shell -cd fish-shell -autoreconf && ./configure -make && sudo make install -``` - -### 4. フィッシュシェルをデフォルトのシェルにするには？ +### 2. フィッシュシェルをデフォルトのシェルにするには？ システムの`/etc/shells`ファイルに、fishを追加して下さい。 @@ -170,7 +148,7 @@ echo "/usr/local/bin/fish" | sudo tee -a /etc/shells chsh -s /usr/local/bin/fish ``` -### 5. fishermanを削除する方法とは？ +### 3. fishermanを削除する方法とは？ はい。 @@ -178,11 +156,11 @@ chsh -s /usr/local/bin/fish fisher self-uninstall ``` -### 6. oh-my-fishのプラグインとテーマに対応ですか？ +### 4. oh-my-fishのプラグインとテーマに対応ですか？ 対応です。 -### 7. なぜfisherman? +### 5. なぜfisherman? * 小さくて一つのファイルでOK @@ -194,7 +172,7 @@ fisher self-uninstall * XDGディレクトリ方針を従う -### 8. fishermanのファイル等は、どこに保存されますか？ +### 6. fishermanのファイル等は、どこに保存されますか？ fisherman自体は`~/.config/fish/functions/fisher.fish`に。 @@ -202,7 +180,7 @@ fisherman自体は`~/.config/fish/functions/fisher.fish`に。 fishfileは`~/.config/fish/fishfile`に。 -### 9. fishfileとは？ +### 7. fishfileとは？ fishfile（`~/.config/fish/fishfile`）に現在インストールされているプラグインを記入してあります。 @@ -218,15 +196,15 @@ omf/grc この仕組はプラグインと、そのプラグインのデペンデンシーをインストールすることができます。プラグインを削除するために、`fisher rm`を使ってください。 -### 10. フィッシュシェルのプラグインはどこにありますか？ +### 8. フィッシュシェルのプラグインはどこにありますか？ fishermanの[organization]や、[ウェブサイト]等で、プラグインを検索できます。 -### 11. 他のシステムからのアップグレード方法とは？ +### 9. 他のシステムからのアップグレード方法とは？ fishermanは他のフィッシュシェルフレームワーク等に関係ないです。もし、oh-my-fish等をアンインストールしたい場合、あちらのドキュメンテーションを参考してください。 -### 13. プラグインとは？ +### 10. プラグインとは？ プラグインとは @@ -236,7 +214,7 @@ fishermanは他のフィッシュシェルフレームワーク等に関係な 3. スニペット。つまり、1以上の`.fish`ファイルを`conf.d`といディレクトリに。こちらのファイルがフィッシュシェルがスタートする際に実行されます。 -### 14. 自分のプラグインを、他のプラグインのデペンデンシーにしたい場合は？ +### 11. 自分のプラグインを、他のプラグインのデペンデンシーにしたい場合は？ プラグインのrootディレクトリに`fishfile`編集して、そのプラグインを打ってください。 @@ -246,11 +224,11 @@ https://github.com/dude/sweet https://gist.github.com/bucaran/c256586044fea832e62f02bc6f6daf32 ``` -### 15. fundleはどう？ +### 12. fundleはどう？ fundleを参考しながら、vundleのようにfishfileを使いたいと思いましたが、fundle自体はまだ特徴はすくないですし、フィッシュシェルの設定をいじることは必要です。 -### 16. 質問がありますが、どこに書いたらいいですか？ +### 13. 質問がありますが、どこに書いたらいいですか？ 新しいissueを作って頂いて、英語でも、日本語でも対応しております。 diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 4130ed5..2d2a122 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -139,29 +139,7 @@ for file in ~/.config/fish/conf.d/*.fish end ``` -### 2. 如何从 OS X 安装 fish? - -使用 Homebrew。 - -``` -brew install fish -``` - -### 3. 如何从一些 linux 发行版安装最近版本的 fish? - -使用 git 或者上游源。 - -```sh -sudo apt-get -y install git gettext automake autoconf \ - ncurses-dev build-essential libncurses5-dev - -git clone -q --depth 1 https://github.com/fish-shell/fish-shell -cd fish-shell -autoreconf && ./configure -make && sudo make install -``` - -### 4. 如何让 fish 作为我默认的 shell ? +### 2. 如何让 fish 作为我默认的 shell ? Add fish to the list of login shells in `/etc/shells` and make it your default shell. 把 fish 加入到 `/etc/shells` 并令 fish 成为默认 shell。 @@ -171,7 +149,7 @@ echo "/usr/local/bin/fish" | sudo tee -a /etc/shells chsh -s /usr/local/bin/fish ``` -### 5. 如何卸载 fisherman？ +### 3. 如何卸载 fisherman？ 运行以下命令。 @@ -179,11 +157,11 @@ chsh -s /usr/local/bin/fish fisher self-uninstall ``` -### 6. fisherman 兼容已有的 fish 主题和插件吗？ +### 4. fisherman 兼容已有的 fish 主题和插件吗？ 是的。 -### 7. 为什么选择 fisherman？ +### 5. 为什么选择 fisherman？ fisherman 有以下特色： @@ -197,13 +175,13 @@ fisherman 有以下特色： * 符合 [XDG](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) 规范 -### 8. fisherman 把数据放到哪里了？ +### 6. fisherman 把数据放到哪里了？ fisherman 的位置在 `~/.config/fish/functions/fisher.fish`。 缓存和插件配置被分别存在 `~/.cache/fisherman` 和 `~/.config/fisherman`。 fishfile 位置在 `~/.config/fish/fishfile`。 -### 9. 什么是 fishfile 以及如何使用它？ +### 7. 什么是 fishfile 以及如何使用它？ fishfile `~/.config/fish/fishfile` 列出了所有已安装的插件。 @@ -218,15 +196,15 @@ omf/grc 这个文件只会记录插件和一些依赖。如果你想卸载插件，可以使用 `fisher rm`来替代。 -### 10. 去哪里可以找到插件？ +### 8. 去哪里可以找到插件？ 看看这个 [organization] 或者使用这个 [online] 来搜索。 -### 11. 如何从 ____ 更新？ +### 9. 如何从 ____ 更新？ fisherman 没有引入其他任何已知的框架。如果你想卸载 oh my fish, 看它的文档即可 -### 12. 什么是一个插件？ +### 10. 什么是一个插件？ 一个插件是： @@ -236,7 +214,7 @@ fisherman 没有引入其他任何已知的框架。如果你想卸载 oh my fis 3. 一些代码片段，比如一个或多个在 `conf.d`目录下的 `.fish` 文件并且它们会在 shell 启动时执行。 -### 13. 如何把这些插件作为我自己插件的依赖？ +### 11. 如何把这些插件作为我自己插件的依赖？ 在项目的顶层目录创建一个新的 `fishfile` 文件，并写下你的依赖。 @@ -246,11 +224,11 @@ https://github.com/dude/sweet https://gist.github.com/bucaran/c256586044fea832e62f02bc6f6daf32 ``` -### 14. 什么是 fundle? +### 12. 什么是 fundle? fundle 启发我去使用打包的文件，但是目前它仍然有着一些功能限制，需要你去调整 fish 配置。 -### 15. 我有一些问题想提交？ +### 13. 我有一些问题想提交？ 在 gituhb issue 上创建一个新的工单：