From d3dbe2624d88a1963c77598b02b5b7dd37bb2186 Mon Sep 17 00:00:00 2001 From: Jorge Bucaran Date: Sat, 21 May 2016 18:07:37 +0900 Subject: [PATCH] Remove docs directory. * Move translations to the wiki to encourage anyone to contribute without going through a full PR. --- README.md | 18 ++-- docs/ca-ES/README.md | 201 ---------------------------------------- docs/es-ES/README.md | 214 ------------------------------------------- docs/jp-JA/README.md | 200 ---------------------------------------- docs/ko-KR/README.md | 204 ----------------------------------------- docs/pt-PT/README.md | 191 -------------------------------------- docs/ru-RU/README.md | 153 ------------------------------- docs/zh-CN/README.md | 169 ---------------------------------- 8 files changed, 9 insertions(+), 1341 deletions(-) delete mode 100644 docs/ca-ES/README.md delete mode 100644 docs/es-ES/README.md delete mode 100644 docs/jp-JA/README.md delete mode 100644 docs/ko-KR/README.md delete mode 100644 docs/pt-PT/README.md delete mode 100644 docs/ru-RU/README.md delete mode 100644 docs/zh-CN/README.md diff --git a/README.md b/README.md index 9210a32..6e11917 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ [fish]: https://fish.sh [fisherman]: http://fisherman.sh -[日本語]: docs/jp-JA -[简体中文]: docs/zh-CN -[한국어]: docs/ko-KR -[Русский]: docs/ru-RU -[Català]: docs/ca-ES -[Português]: docs/pt-PT -[Español]: docs/es-ES +[日本語]: https://github.com/fisherman/fisherman/wiki/%E6%97%A5%E6%9C%AC%E8%AA%9E +[简体中文]: https://github.com/fisherman/fisherman/wiki/%E7%AE%80%E4%BD%93%E4%B8%AD%E6%96%87 +[한국어]: https://github.com/fisherman/fisherman/wiki/%ED%95%9C%EA%B5%AD%EC%96%B4 +[Русский]: https://github.com/fisherman/fisherman/wiki/%D0%A0%D1%83%D1%81%D1%81%D0%BA%D0%B8%D0%B9 +[Català]: https://github.com/fisherman/fisherman/wiki/Catal%C3%A0 +[Português]: https://github.com/fisherman/fisherman/wiki/Portugu%C3%AAs +[Español]: https://github.com/fisherman/fisherman/wiki/Espa%C3%B1ol [![Build Status][travis-badge]][travis-link] [![Slack][slack-badge]][slack-link] @@ -34,7 +34,7 @@ curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman Install a plugin. ``` -fisher sol +fisher mono ``` Install from multiple sources. @@ -67,7 +67,7 @@ List what you've installed. ```ApacheConf fisher ls @ plugin # a local plugin -* sol # current prompt +* mono # current prompt bass fzf thefuck diff --git a/docs/ca-ES/README.md b/docs/ca-ES/README.md deleted file mode 100644 index a14b792..0000000 --- a/docs/ca-ES/README.md +++ /dev/null @@ -1,201 +0,0 @@ -[slack-link]: https://fisherman-wharf.herokuapp.com -[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg -[travis-link]: https://travis-ci.org/fisherman/fisherman -[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg - -[organització]: https://github.com/fisherman -[fish]: https://github.com/fish-shell/fish-shell -[fisherman]: http://fisherman.sh -[en línia]: http://fisherman.sh/#search - -[English]: ../../README.md - -[![Build Status][travis-badge]][travis-link] -[![Slack][slack-badge]][slack-link] - -# [fisherman] - -fisherman és un gestor de complements per a [fish]. - -## Instal·la - -Amb curl. - -```sh -curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman -``` - -## Mode d'ús - -Instal·la un complement. - -``` -fisher sol -``` - -Instal·la des de múltiples fonts. - -``` -fisher z fzf edc/bass omf/thefuck -``` - -Instal·la des de una URL. - -``` -fisher https://github.com/edc/bass -``` - -Instal·la des de un gist. - -``` -fisher https://gist.github.com/username/1f40e1c6e0551b2666b2 -``` - -Instal·la des de un directori local. - -```sh -fisher ~/plugin -``` - -Edita el teu arxiu fishfile i executa `fisher` per a aplicar els canvis. - -> [Que és un arxiu fishfile i com el faig anar?](#6-que-és-un-arxiu-fishfile-i-com-el-faig-anar) - -```sh -$EDITOR fishfile # afegeix complements -fisher -``` - -Fes un cop d'ull al que tens instal·lat. - -```ApacheConf -fisher ls -@ plugin # aquest complement esta dins un directori local -* sol # aquest complement es el tema actual - bass - fzf - grc - thefuck - z -``` - -Tria el que pots instal·lar. - -``` -fisher ls-remote -``` - -Actualitza-ho tot. - -``` -fisher up -``` - -Actualitza alguns complements. - -``` -fisher up bass z fzf thefuck -``` - -Esborra alguns complements. - -``` -fisher rm thefuck -``` - -Esborra tots els complements. - -``` -fisher ls | fisher rm -``` - -Aconsegueix ajuda. - -``` -fisher help z -``` - -## FAQ - -### Quina es la versió necessaria de fish? - -fisherman va ésser construït per a fish >= 2.3.0. Si estàs fent anar la versió 2.2.0, -afegeix el següent codi al teu arxiu `~/.config/fish/config.fish` per a donar suport a [retalls](#8-que-es-un-complement). - -```fish -for file in ~/.config/fish/conf.d/*.fish - source $file -end -``` - -### Com converteixo fish en la meva consola de comandes per defecte? - -Afegeix fish a la llista de consoles de comandes dins de l'arxiu */etc/shells* i converteix-la en la teva consola de comandes per defecte. - -```sh -echo "/usr/local/bin/fish" | sudo tee -a /etc/shells -chsh -s /usr/local/bin/fish -``` - -### Com des-instal·lo fisherman? - -```fish -fisher self-uninstall -``` - -o - -``` -npm un -g fisherman -``` - -### És fisherman compatible amb els temes i complements de oh my fish? - -Si. - -### On deixa fisherman les seves coses? - -fisherman es guarda al directori *~/.config/fish/functions/fisher.fish*. - -La caché i configuracions són creades dins de *~/.cache/fisherman* i *~/.config/fisherman* respectivament. - -El arxiu fishfile es guarda a *~/.config/fish/fishfile*. - -### Que és un arxiu fishfile i com el faig anar? - -El arxiu fishfile *~/.config/fish/fishfile* llista tots els complements instal·lats. - -Pots deixar que en fisherman s'encarregui d'aquest arxiu per tu automaticament, o be escriure a dins els complements que vols instal·lar i llavors executar `fisher` per a aplicar els canvis. - -``` -fisherman/sol -fisherman/z -omf/thefuck -omf/grc -``` - -Aquest procediment només instal·la complements i dependències. Per esborrar complements, fes anar `fisher rm` al seu lloc. - -### On puc trobar una llista de complements de fish? - -Busca dins de l'[organització] o fes anar la busqueda [en línia] per descobrir contingut. - -### Que es un complement? - -Un complement es: - -1. un directori o repositori de git amb una funció dins d'un arxiu *.fish* ja be a l'arrel del projecte o dins d'un directori *functions* - -2. un tema o prompt, p.e., un *fish_prompt.fish*, *fish_right_prompt.fish* o ambdós - -3. un retall, p.e., un o mes arxius *.fish* dins un directori anomenat *conf.d* que es evaluat per fish a l'arrencada de la consola de comandes. - -### Com puc llistar complements com dependencies del meu complement? - -Crea un nou arxiu *fishfile* a l'arrel del teu i escriu a dins les dependències del teu complement. - -```fish -owner/repo -https://github.com/owner/repo -https://gist.github.com/owner/c256586044fea832e62f02bc6f6daf32 -``` diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md deleted file mode 100644 index 01fa47b..0000000 --- a/docs/es-ES/README.md +++ /dev/null @@ -1,214 +0,0 @@ -[slack-link]: https://fisherman-wharf.herokuapp.com/ -[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg -[travis-link]: https://travis-ci.org/fisherman/fisherman -[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg - -[organización]: https://github.com/fisherman -[fish]: https://github.com/fish-shell/fish-shell -[fisherman]: http://fisherman.sh -[en línea]: http://fisherman.sh/#search - -[![Build Status][travis-badge]][travis-link] -[![Slack][slack-badge]][slack-link] - -# [fisherman] - -fisherman es un gestor de paquetes para [fish]. - -## Prestaciones - -* Sin configuración - -* Sin dependencias externas - -* No afecta al tiempo de inicio de la sesión - -* Se puede utilizar de manera interactiva o con un archivo fishfile - -* Instala i actualiza paquetes de manera concurrente - -* Solo lo fundamental, install, update, remove, list y help - -## Instalación - -Via curl. - -```sh -curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman -``` - -## Modo de uso - -Instalar paquetes. - -``` -fisher sol -``` - -Instalar desde múltiples fuentes. - -``` -fisher z fzf edc/bass omf/thefuck -``` - -Instalar desde URLs. - -``` -fisher https://github.com/edc/bass -``` - -Instalar desde gists. - -``` -fisher https://gist.github.com/username/1f40e1c6e0551b2666b2 -``` - -Instalar desde un directorio. - -```sh -fisher ~/plugin -``` - -Edita el archivo fishfile y ejecuta `fisher` para aplicar los cambios. - -> [¿Qué es el archivo fishfile y cómo lo utilizo?](#6-qué-es-el-fishfile-y-cómo-lo-uso) - -```sh -$EDITOR fishfile # añade los paquetes como dependencias -fisher -``` - -Muestra que tienes instalado actualmente. - -```ApacheConf -fisher ls -@ plugin # este paquete esta en un directorio -* sol # este paquete es el tema actual - bass - fzf - grc - thefuck - z -``` - -Muestra que puedes instalar. - -``` -fisher ls-remote -``` - -Actualiza todo. - -``` -fisher up -``` - -Actualiza algunos paquetes. - -``` -fisher up bass z fzf thefuck -``` - -Elimina paquetes. - -``` -fisher rm thefuck -``` - -Elimina todos los paquetes. - -``` -fisher ls | fisher rm -``` - -Muestra ayuda. - -``` -fisher help z -``` - -## FAQ - -### ¿Qué versión de fish es necesaria? - -fisherman fue diseñado para fish >= 2.3.0. Si tienes la versión 2.2.0 y no puedes actualizarla por algún motivo, añade este código en el archivo `~/.config/fish/config.fish` para poder ejecutar [snippets](#8-qué-es-un-paquete). - -```fish -for file in ~/.config/fish/conf.d/*.fish - source $file -end -``` - -### ¿Cómo hago fish mi consola de comandos por defecto? - -Añade fish a la lista de consolas de comandos en */etc/shells*. - -```sh -echo "/usr/local/bin/fish" | sudo tee -a /etc/shells -chsh -s /usr/local/bin/fish -``` - -### ¿Cómo puedo desinstalar fisherman? - -Ejecuta - -```fish -fisher self-uninstall -``` - -o - -```fish -npm un -g fisherman -``` - -### ¿Es fisherman compatible con paquetes y temas de oh my fish? - -Sí. - -### ¿Dónde guarda fisherman sus cosas? - -fisherman mismo esta en el archivo *~/.config/fish/functions/fisher.fish*. - -El caché y la configuración en *~/.cache/fisherman* y *~/.config/fisherman* respectivamente. - -El archivo fishfile en *~/.config/fish/fishfile*. - -### ¿Qué es el archivo fishfile y cómo lo uso? - -El archivo fishfile *~/.config/fish/fishfile* contiene todos los paquetes que están instalados. - -Puedes dejar que fisherman se encargue de este archivo automáticamente, o incluir los paquetes que necesitas y ejecutar `fisher` para aplicar los cambios. - -``` -fisherman/sol -fisherman/z -omf/thefuck -omf/grc -``` - -Este comando solo instala paquetes y sus dependencias. Para borrar paquetes, usa `fisher rm`. - -### ¿Dónde consigo un listado de paquetes para fish? - -Dirígete a la [organización] o usa la búsqueda [en línea] para descubrir contenido. - -### ¿Qué es un paquete? - -Un paquete es: - -1. un directorio o repositorio de git con una función / archivo *.fish* bien sea en el directorio raíz del proyecto o en un directorio llamado *functions*. - -2. un tema o prompt, es decir, *fish_prompt.fish*, *fish_right_prompt.fish* o ambos. - -3. un snippet, es decir, uno o más archivos *.fish* en un directorio llamado *conf.d* que son ejecutados por fish al iniciar la sesión. - -### ¿Cómo puedo añadir dependencias a mi plugin? - -Crea un archivo *fishfile* en la carpeta raíz de tu plugin y incluye los paquetes en el. - -```fish -owner/repo -https://github.com/owner/repo -https://gist.github.com/owner/c256586044fea832e62f02bc6f6daf32 -``` diff --git a/docs/jp-JA/README.md b/docs/jp-JA/README.md deleted file mode 100644 index 7eb763a..0000000 --- a/docs/jp-JA/README.md +++ /dev/null @@ -1,200 +0,0 @@ -[slack-link]: https://fisherman-wharf.herokuapp.com/ -[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg -[travis-link]: https://travis-ci.org/fisherman/fisherman -[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg - -[organization]: https://github.com/fisherman -[fish]: https://github.com/fish-shell/fish-shell -[fisherman]: http://fisherman.sh -[ウェブサイト]: http://fisherman.sh/#search - -[![Build Status][travis-badge]][travis-link] -[![Slack][slack-badge]][slack-link] - -# [fisherman] - -fisherman とは [fish]のための並列処理パッケージマネージャーです。 - -## 理由 - -* 設定なし - -* 依存性なし - -* フィッシュシェルのスタート時間に関係ない - -* cli から利用可能であり、vundle のようにも使える - -* 基本のコマンドは install、update、remove、list と help だけ - -## インストール - -curl: - -```sh -curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman -``` - -## 使い方 - -プラグインをインストール: - -``` -fisher sol -``` - -様々な所からもインストール: - -``` -fisher z fzf edc/bass omf/thefuck -``` - -URL からインストール: - -``` -fisher https://github.com/edc/bass -``` - -Gist をインストール: - -``` -fisher https://gist.github.com/username/1f40e1c6e0551b2666b2 -``` - -ディレクトリをインストール: - -```sh -fisher ~/plugin -``` - -vundleのように 「fishfile」というファイルにプラグインたちを追加して `fisher` でインストール： - -> [fishfileとは？](#6-fishfileとは) - -```sh -$EDITOR fishfile # プラグイン追加 -fisher -``` - -インストールされるプラグイン表示： - -```ApacheConf -fisher ls -@ plugin # ローカルディレクトリ -* sol # 現在のテーマ - bass - fzf - grc - thefuck - z -``` - -すべてのプラグインをアップデート： - -``` -fisher up -``` - -いくつかのプラグインをアップデート： - -``` -fisher up bass z fzf thefuck -``` - -プラグインを削除： - -``` -fisher rm thefuck -``` - -すべてのプラグインを削除： - -``` -fisher ls | fisher rm -``` - -ドキュメントを表示： - -``` -fisher help z -``` - -## FAQ - -### fishの必要なバージョンとは？ - -fish >= 2.3.0 が必要です。まだ 2.2.0 を使っているのならば [snippets](#8-プラグインとは) の対応のため次のコードを `~/.config/fish/config.fish` に追記してください。 - -```fish -for file in ~/.config/fish/conf.d/*.fish - source $file -end -``` - -### フィッシュシェルをデフォルトのシェルにするには？ - -システムの */etc/shells* ファイルに、fish を追加: - -```sh -echo "/usr/local/bin/fish" | sudo tee -a /etc/shells -chsh -s /usr/local/bin/fish -``` - -### fishermanを削除する方法とは？ - -```fish -fisher self-uninstall -``` - -もしくは - -```fish -npm un -g fisherman -``` - -### oh-my-fishのプラグインとテーマに対応ですか？ - -対応してます - -### fishermanのファイル等は、どこに保存されますか？ - -fisherman 自体は *~/.config/fish/functions/fisher.fish* に作成されます。そしてキャシュは*~/.cache/fisherman*に、コンフィグディレクトリは *~/.config/fisherman* に。fishfileは*~/.config/fish/fishfile*に保存されます - -### fishfileとは？ - -fishfile（*~/.config/fish/fishfile*）に現在インストールされているプラグインが書かれています。 - -fisherman で自動的にこのファイルを更新するか、手動でプラグインを追加して `fisher`を入力してインストールすることも可能です。 - -``` -fisherman/sol -fisherman/z -omf/thefuck -omf/grc -``` - -この仕組はプラグインと、そのプラグインが依存しているものをインストールすることができます。プラグインを削除するために、`fisher rm`を使ってください。 - -### フィッシュシェルのプラグインはどこにありますか？ - -fisherman の [organization] や [ウェブサイト] 等で、プラグインを検索できます。 - -### プラグインとは？ - -プラグインとは - -1. 普通のディレクトリや、gitレポジトリのrootに、*.fish*ファイルの関数、それか、*functions*ディレクトリに。 - -2. テーマ。つまり、*fish_prompt.fish*か*fish_right_prompt.fish*か両方。 - -3. スニペット。つまり、1以上の*.fish*ファイルを*conf.d*といディレクトリに。こちらのファイルがフィッシュシェルがスタートする際に実行されます。 - -### 自分のプラグインを、他のプラグインのデペンデンシーにしたい場合は？ - -プラグイン root ディレクトリの *fishfile* 編集してそのプラグインを追加してください。 - -```fish -owner/repo -https://github.com/owner/repo -https://gist.github.com/owner/c256586044fea832e62f02bc6f6daf32 -``` diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md deleted file mode 100644 index 1974509..0000000 --- a/docs/ko-KR/README.md +++ /dev/null @@ -1,204 +0,0 @@ -[slack-link]: https://fisherman-wharf.herokuapp.com -[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg -[travis-link]: https://travis-ci.org/fisherman/fisherman -[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg - -[organization]: https://github.com/fisherman -[fish]: https://github.com/fish-shell/fish-shell -[fisherman]: http://fisherman.sh -[online]: http://fisherman.sh/#search - -[![Build Status][travis-badge]][travis-link] -[![Slack][slack-badge]][slack-link] - -# [fisherman] - -fisherman은 [fish]을 위한 병렬 처리 플러그인 매니저 입니다. - -## 왜 fisherman을 사용해야 하죠? - -* 설정 없음 - -* 의존성 없음 - -* Shell 시작 시간에 영향 없음 - -* 설치, 업데이트, 제거, 목록, 도움말의 필수 기능에 집중 - -* 커멘드라인을 통한 인터렉티브 관리 혹은 플러그인 패키지 파일로 부터 일괄 관리 지원 - -## 설치 - -curl를 통한 설치: - -```sh -curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman -``` - -## 사용법 - -플러그인 설치: - -``` -fisher sol -``` - -여러 출처로 부터 한꺼번에 설치: - -``` -fisher z fzf edc/bass omf/thefuck -``` - -URL를 통해 설치: - -``` -fisher https://github.com/edc/bass -``` - -gist로 부터 설치: - -``` -fisher https://gist.github.com/username/1f40e1c6e0551b2666b2 -``` - -로컬 디렉토리로 부터 설치: - -```sh -fisher ~/plugin -``` - -플러그인 패키지 관리 파일로 정의하고 `fisher` 명령어로 변경사항을 적용: - -> [fishfile이 뭐죠? 어떻게 사용하나요?](#6-fishfile이-뭐죠?-어떻게-사용하나요?) - -```sh -$EDITOR fishfile # 플러그인 추가 -fisher -``` - -설치된 플러그인 확인: - -```ApacheConf -fisher ls -@ plugin # 로컬 디렉토리 설치 플러그인 -* sol # 현재 사용되고 있는 프롬프트 스타일 플러그인 - bass - fzf - grc - thefuck - z -``` - -모두 업데이트: - -``` -fisher up -``` - -일부 업데이트: - -``` -fisher up bass z fzf thefuck -``` - -플러그인 삭제: - -``` -fisher rm thefuck -``` - -모든 플러그인 삭제: - -``` -fisher ls | fisher rm -``` - -도움말 보기: - -``` -fisher help z -``` - -## 자주묻는 질문과 답변 - -### 필요로하는 fish shell 버전은? - -fisherman은 fish shell 버전 2.3.0 이상부터 지원합니다. 만약 2.2.0을 사용하고 있다면 [코드조각](#8-플러그인이-뭐죠?) 지원을 위하여 아래의 코드를 `~/.config/fish/config.fish`에 추가해 주세요. - -```fish -for file in ~/.config/fish/conf.d/*.fish - source $file -end -``` - -### 어떻게 fish를 기본 shell로 지정하나요? - -*/etc/shells* 파일에 있는 shell 목록에 fish를 추가하고, 기본 shell로 지정합니다. - -```sh -echo "/usr/local/bin/fish" | sudo tee -a /etc/shells -chsh -s /usr/local/bin/fish -``` - -### fisherman을 삭제하고 싶어요. - -```fish -fisher self-uninstall -``` - -혹은 - -``` -npm un -g fisherman -``` - -### fisherman은 oh my fish 패키지 관리자의 테마, 플러그인과 호환 되나요? - -네. - -### fisherman은 어디에 파일을 두나요? - -fisherman 자체는 *~/.config/fish/functions/fisher.fish* 입니다. - -캐쉬와 플러그인 관리 파일은 각각 *~/.cache/fisherman* 과 *~/.config/fisherman* 을 관례로 사용합니다. - -fishfile은 *~/.config/fish/fishfile* 에 위치합니다. - -### fishfile이 뭐죠? 어떻게 사용하나요? - -fishfile은 *~/.config/fish/fishfile* 위치하며 모든 설치 플러그인의 목록이 담겨있습니다. - -fisherman 명령어를 통해 플러그인을 설치/제거하면 자동으로 fishfile이 관리됩니다. 혹은, fishfile에 직접 플러그인을 추가하고 `fisher` 명령어를 입력하면 변경사항이 적용됩니다. - -``` -fisherman/sol -fisherman/z -omf/thefuck -omf/grc -``` - -이 방식은 설치나 이가 빠진 의존성에만 작동 합니다. 플러그인을 삭제하려면, `fisher rm`명령어를 사용하세요. - -### 어디서 플러그인을 찾을 수 있나요? - -fisherman의 [organization] 페이지를 살펴보거나 [online] 플러그인 목록에서 찾아보세요. - -### 플러그인이 뭐죠? - -플러그인은: - -1. 최상단 혹은 최상단에 위치한 *functions* 디렉토리에 담긴 *.fish* 파일이 기능으로 작동하는 디렉토리 혹은 git 저장소 - -2. 테마 혹은 프롬프트. 예: *fish_prompt.fish* 이거나 *fish_right_prompt.fish* 혹은 두 파일 전부 - -3. 코드 조각. 예: fish shell 시작시 불러들이게 되는 *conf.d* 디렉토리 안에 위치 한 *.fish* 파일들 - -### 플러그인 제작시 의존성을 명시하는 방법이 있나요? - -작성하는 플러그인 최상단 디렉토리에 *fishfile* 를 만들고 의존성을 나열하세요. - -```fish -owner/repo -https://github.com/owner/repo -https://gist.github.com/owner/c256586044fea832e62f02bc6f6daf32 -``` diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md deleted file mode 100644 index b19e805..0000000 --- a/docs/pt-PT/README.md +++ /dev/null @@ -1,191 +0,0 @@ -[slack-link]: https://fisherman-wharf.herokuapp.com/ -[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg -[travis-link]: https://travis-ci.org/fisherman/fisherman -[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg - -[organização]: https://github.com/fisherman -[fish]: https://github.com/fish-shell/fish-shell -[fisherman]: http://fisherman.sh -[online]: http://fisherman.sh/#search - -[![Build Status][travis-badge]][travis-link] -[![Slack][slack-badge]][slack-link] - -# [fisherman] - -fisherman é um gestor de plugins para [fish]. - -## Instalação - -Via curl. - -```sh -curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman -``` - -## Uso - -Instalar um plugin. - -``` -fisher sol -``` - -Instalar através de múltiplas fontes. - -``` -fisher z fzf edc/bass omf/thefuck -``` - -Instalar através de URLs. - -``` -fisher https://github.com/edc/bass -``` - -Instalar através de gists. - -``` -fisher https://gist.github.com/username/1f40e1c6e0551b2666b2 -``` - -Instalar através de uma pasta local. - -```sh -fisher ~/plugin -``` - -Edite o ficheiro fishfile e execute `fisher` para aplicar as alterações - -> [O que é o ficheiro fishfile e como é que eu o utilizo?](#6-o-que-é-o-ficheiro-fishfile-e-como-é-que-eu-o-utilizo) - -```sh -$EDITOR fishfile # adicionar plugins -fisher -``` - -Mostrar os plugins instalados actualmente. - -```ApacheConf -fisher ls -@ plugin # este plugin é uma pasta local -* sol # este plugin é o Tema da consola - bass - fzf - grc - thefuck - z -``` - -Mostrar os plugins disponíveis para instalação. - -``` -fisher ls-remote -``` - -Actualizar fihserman e todos os plugins. - -``` -fisher up -``` - -Actualizar plugins específicos. - -``` -fisher up bass z fzf thefuck -``` - -Remover plugins. - -``` -fisher rm thefuck -``` - -Remover todos os plugins instalados. - -``` -fisher ls | fisher rm -``` - -Mostrar ajuda. - -``` -fisher help z -``` - -## FAQ - -### Qual é a versão da fish necessária? - -fisherman foi desenhado para fish >= 2.3.0. Se está a usar a versão 2.2.0, é necessário adicionar o seguinte código no seu ficheiro `~/.config/fish/config.fish` de formar a suportar [snippets](#8-o-que-é-um-plugin). - -```fish -for file in ~/.config/fish/conf.d/*.fish - source $file -end -``` - -### Como faço para tornar fish a minha consola predefinida? - -Adicione fish à lista de consolas no ficheiro */etc/shells* e defina-a como a sua consola por omissão usando os seguintes comandos. - -```sh -echo "/usr/local/bin/fish" | sudo tee -a /etc/shells -chsh -s /usr/local/bin/fish -``` - -### Como faço para desinstalar fisherman? -```fish -fisher self-uninstall -``` - -### O fisherman é compatível com os plugins e temas do oh my fish? - -Sim. - -### Onde é que o fisherman guarda as suas coisas? - -O fisherman é guardado no ficheiro *~/.config/fish/functions/fisher.fish*. - -A cache e a configuração é guardada nos ficheiros *~/.cache/fisherman* e *~/.config/fisherman* respectivamente. - -O ficheiro fishfile é guardado em *~/.config/fish/fishfile*. - -### O que é o ficheiro fishfile e como é que eu o utilizo? - -O ficheiro fishfile *~/.config/fish/fishfile* contém todos os plugins instalados. - -Pode deixar que fisherman tome conta deste ficheiro automaticamente, ou se quiser, pode adicionar os plugins manualmente ao ficheiro e no fim executar `fisher` para aplicar as alterações. - -``` -fisherman/sol -fisherman/z -omf/thefuck -omf/grc -``` - -Este comando apenas instalas plugins e suas dependências. Para desinstalar um plugin, tem que executar `fisher rm `. - -### Onde consigo ver os plugins disponíveis para instalação? - -Visite a [organização] ou use a pesquisa [online] para descobrir os plugins disponíveis. - -### O que é um plugin? - -Um plugin é: - -1. uma pasta local ou repositório git com uma função dentro de um ficheiro *.fish* na raiz da pasta ou repositório ou dentro de uma pasta chamada *functions*. - -2. um tema ou um prompt, i.e, *fish_prompt.fish*, *fish_right_prompt.fish* ou ambos. - -3. um snippet, i.e, um ou mais ficheiros *.fish* dentro de uma pasta chamada *conf.d* que são executados sempre por fish no arranque da consola. - -### Como posso definir plugins como dependências do meu plugin? - -Crie um ficheiro *fishfile* na raiz do seu projecto e adicione ao ficheiros as dependências. - -```fish -owner/repo -https://github.com/owner/repo -https://gist.github.com/owner/c256586044fea832e62f02bc6f6daf32 -``` diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md deleted file mode 100644 index 5c61761..0000000 --- a/docs/ru-RU/README.md +++ /dev/null @@ -1,153 +0,0 @@ -[slack-link]: https://fisherman-wharf.herokuapp.com/ -[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg -[travis-link]: https://travis-ci.org/fisherman/fisherman -[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg - -[fish]: https://github.com/fish-shell/fish-shell -[fisherman]: https://github.com/fisherman.sh - -[![Build Status][travis-badge]][travis-link] -[![Slack][slack-badge]][slack-link] - -# [fisherman] - -Менеджер плагинов для [fish]. - -## Установка - -```sh -curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman -``` - -## Использование - -Установка отдельного плагина. - -``` -fisher sol -``` - -Установка из нескольких источников. - -``` -fisher z fzf edc/bass omf/thefuck -``` - -Установка из gist. - -``` -fisher https://gist.github.com/username/1f40e1c6e0551b2666b2 -``` - -Установка из локального каталога. - -```sh -fisher ~/plugin -``` - -Отредактируйте [fishfile](#Что-такое-fishfile-и-как-я-могу-его-использовать) и запустите `fisher`, чтобы изменения вступили в силу. - -```sh -$EDITOR ~/.config/fish/fishfile -fisher -``` - -Список установленных плагинов. - -```ApacheConf -fisher ls -@ plugin # локальный плагин -* sol # текущее оформление командной строки - bass - fzf - thefuck - z -``` - -Список доступных плагинов. - -``` -fisher ls-remote -``` - -Обновление всего сразу. - -``` -fisher up -``` - -Обновление отдельных плагинов. - -``` -fisher up bass z fzf -``` - -Удаление плагинов. - -``` -fisher rm thefuck -``` - -Удаление всех плагинов. - -``` -fisher ls | fisher rm -``` - -Справка по плагину. - -``` -fisher help z -``` - -Удаление fisherman. - -``` -fisher self-uninstall -``` - -## Часто задаваемые вопросы - -### Какая версия fish необходима? - -\>=2.2.0. - -Для поддержки [cниппетов](#Что-такое-плагин) обновите fish до версии >= 2.3.0 или добавьте следующий код в ваш `~/.config/fish/config.fish`: - -```fish -for file in ~/.config/fish/conf.d/*.fish - source $file -end -``` - -### Совместим ли fisherman с темами и плагинами oh my fish? - -Да. - -### Где fisherman хранит данные? - -Кэш и настройки плагинов находятся в *~/.cache/fisherman* и *~/.config/fisherman* соответственно. - -fishfile сохраняется в *~/.config/fish/fishfile*. - -### Что такое fishfile и как я могу его использовать? - -В *~/.config/fish/fishfile* хранится список всех установленных плагинов. - -fisherman обновляет этот файл автоматически, но вы также можете добавить плагины в список вручную и запустить `fisher`, чтобы эти изменения вступили в силу. - -Этот механизм только устанавливает плагины и отсутствующие зависимости. Чтобы удалить плагин, используйте `fisher rm`. - -### Что такое плагин? - -Плагином является: - -1. каталог или git репозиторий с файлом *.fish* либо на корневом уровне проекта, либо в директории *functions* - -2. тема или оформление командной строки, т.е. *fish_prompt.fish*, *fish_right_prompt.fish* или оба файла - -3. сниппет, т.е. один или несколько *.fish* файлов в директории *conf.d*, которые загружаются при запуске fish - -### Как я могу объявить зависимости моего плагина? - -Создайте новый *fishfile* в корне вашего проекта со списком зависимостей. diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md deleted file mode 100644 index 6ca0b07..0000000 --- a/docs/zh-CN/README.md +++ /dev/null @@ -1,169 +0,0 @@ -[slack-link]: https://fisherman-wharf.herokuapp.com/ -[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg -[travis-link]: https://travis-ci.org/fisherman/fisherman -[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg - -[organization]: https://github.com/fisherman -[fish]: https://github.com/fish-shell/fish-shell -[fisherman]: http://fisherman.sh -[online]: http://fisherman.sh/#search - -[![Build Status][travis-badge]][travis-link] -[![Slack][slack-badge]][slack-link] - -# [fisherman] - -fisherman 是 [fish] 的插件管理器。 - -## 安装 - -使用curl。 - -```sh -curl -Lo ~/.config/fish/functions/fisher.fish --create-dirs git.io/fisherman -``` - -## 功能 - -安装插件。 - -``` -fisher sol -``` - -从多个源安装插件。 - -``` -fisher z fzf edc/bass omf/thefuck -``` - -从 Gist 安装插件。 - -``` -fisher https://gist.github.com/username/1f40e1c6e0551b2666b2 -``` - -从本地目录安装插件。 - -```sh -fisher ~/plugin -``` - -使用 [vundle](https://github.com/VundleVim/Vundle.vim) 的方式安装插件，编辑你的 fishfile 并运行 `fisher` 去安装插件。 - -> [什么是 fishfile 以及如何使用它?](#6-什么是-fishfile-以及如何使用它) - -```sh -$EDITOR fishfile -fisher -``` - -查看以安装的插件。 - -```ApacheConf -fisher ls -@ plugin # 该插件是一个本地插件 -* sol # 该插件是当前的命令行提示符插件 - bass - fzf - grc - thefuck - z -``` - -列出远程插件。 -``` -fisher ls-remote -``` - -更新所有插件。 - -``` -fisher up -``` - -更新指定的插件。 - -``` -fisher up bass z fzf thefuck -``` - -移除指定的插件。 - -``` -fisher rm thefuck -``` - -移除所有的插件。 - -``` -fisher ls | fisher rm -``` - -查看插件帮助。 - -``` -fisher help z -``` - -卸载 fisherman -``` -fisher self-uninstall -``` - -## 常见疑问解答 - -### fish 的版本要求多少？ - -fisherman 要求 2.3.0 及以上版本的 fish。如果正在使用 2.2.0 版本，你可以写入以下[代码片段](#8-什么是一个插件)到你的 `~/.config/fish/config.fish`。 - -```fish -for file in ~/.config/fish/conf.d/*.fish - source $file -end -``` - -### fisherman 兼容已有的 fish 主题和插件吗？ - -是的。 - -### fisherman 把数据放到哪里了？ - -fisherman 的位置在 *~/.config/fish/functions/fisher.fish*。 -缓存和插件配置被分别存在 *~/.cache/fisherman* 和 *~/.config/fisherman*。 -fishfile 位置在 *~/.config/fish/fishfile*。 - -### 什么是 fishfile 以及如何使用它？ - -fishfile *~/.config/fish/fishfile* 列出了所有已安装的插件。 - -fisherman 安装插件时，会自动写入这个文件，或者你可以手动写入你想装的插件，然后运行 `fisher` 来安装插件 - -``` -fisherman/sol -fisherman/z -omf/thefuck -omf/grc -``` - -这个文件只会记录插件和一些依赖。如果你想卸载插件，可以使用 `fisher rm`来替代。 - -### 什么是一个插件？ - -一个插件是： - -1. 一个目录或者一个在项目根目录有 *.fish* 文件或者 *functions* 目录的git仓库 - -2. 一个主题或者命令行提示符，比如 `fish-prompt.fish`, *fish_right_prompt.fish*。 - -3. 一些代码片段，比如一个或多个在 *conf.d*目录下的 *.fish* 文件，并且它们会在 shell 启动时执行。 - -### 如何把这些插件作为我自己插件的依赖？ - -在项目的顶层目录创建一个新的 *fishfile* 文件，并写下你的依赖。 - -```fish -owner/repo -https://github.com/owner/repo -https://gist.github.com/owner/c256586044fea832e62f02bc6f6daf32 -```