projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-06-28 23:01:50 +02:00
Code Issues Packages Projects Releases Wiki Activity
823 commits 3 branches 112 tags 2.6 MiB
Commit graph

240 commits

Author SHA1 Message Date
Rodrigo Bermúdez Schettino b47c0469db README: Update function option in conf.d (#497) 
Replace non-existing --event argument with --on-event.
 2018-11-30 09:23:05 +09:00
Tetsuya Ikenaga 60a34e50b4 docs: fix custom fisher_path configuration instructions (#495) 
Avoid doubling `fish_function_path` and `fish_complete_path`.
 2018-11-26 10:08:50 +09:00
Jorge Bucaran a8d7fb7830
docs: improve custom installation prefix instructions; fix #487 2018-11-02 18:08:56 +09:00
Jeremy 9458258f81
docs: Link to awesome-fish-shell list 
As mentioned in https://github.com/jorgebucaran/fisher/issues/461#issuecomment-427638774, a link to the awesome-fish-shell list will help people find packages.
 2018-10-25 09:55:16 +02:00
Jorge Bucaran 40d2882420
docs: improve writing style 2018-10-24 15:43:06 +09:00
Jorge Bucaran 152bdc43a0
docs: improve writing style 2018-10-21 23:33:59 +09:00
Jorge Bucaran b4c4023e16
docs: add additional note to "Using the fishfile" section 2018-10-17 22:38:46 +09:00
Jorge Bucaran 984e245bec
docs: improve "Using the fishfile" section 2018-10-17 22:31:20 +09:00
Jorge Bucaran 7dff47a3f9
docs: improve writing style 2018-10-17 22:30:39 +09:00
Jorge Bucaran f09cefdc5c
doc: fix legacy fish instructions; improve punctuation & grammar 2018-10-17 15:54:12 +09:00
Jorge Bucaran b0c5a6598c
doc: improve various sections 2018-10-17 10:43:51 +09:00
Jorge Bucaran 56e45ef18f
doc: mention packages can be installed from a commit-ish 2018-10-08 20:48:11 +09:00
Jorge Bucaran 206ecf7293
doc: make migration guide more noticeable; #450 2018-10-08 19:56:39 +09:00
Jorge Bucaran 226c0d946f
style: remove html comment; don't use fish code block 2018-10-07 13:53:46 +09:00
Jorge Bucaran 41d5fe0ca6
doc: use git.io/fisher as installation URL since it was restored 2018-10-06 10:00:00 +09:00
Jorge Bucaran 61f6f8c8c4
doc: use raw installation url until https://git.io/fisher is restored 2018-10-06 09:08:40 +09:00
Jorge Bucaran ac3e05ae3e
doc: add upgrading instructions and link to migration guide; #450 2018-10-06 09:07:35 +09:00
Jorge Bucaran 318a1941dc
docs: add link to key bindings info until fish-custom-key-bindings has been published 2018-10-05 23:11:41 +09:00
Jorge Bucaran 54170ef1c3
breaking: implement fisher V3 (#445) 
SUMMARY

This  PR  rewrites  fisher  from  the ground  up  and  adds  new
documentation. It introduces some  breaking changes as described
in the  next section. For  a historical background of  this work
see the original V3 proposal #307 and the more recent discussion
about the future of the project #443.

After much debate  and careful consideration I decided  it is in
the best interest of the  project to keep the CLI-based approach
to  dependency  management as  a  facade  to the  fishfile-based
approach originally proposed.

The new `add` commands (previously  `install`) and good ol' `rm`
interactively update  your fishfile and commit  all your changes
in one  sweep. To the  end user, it's as  if you were  adding or
removing  packages like  you already  do now.  Internally, these
commands affect how the fishfile  is parsed and result in adding
new or replacing/removing existing entries followed by a regular
`fisher` run.

INSTALLING

- `install` has been renamed to `add`

- Installing from a gist is  no longer supported (but it will be
back in a future release—removed only to simplify the rewrite)

- To  install a package  from a tag or  branch use an  at symbol
`@`—the colon `:` is deprecated

LISTING

- `ls` and `rm` are still available with a few minor differences

- `ls` followed by a package name does not list specific package
information (may be added back in a future release)

- `ls`  output format  no longer displays  a legend  to indicate
whether a package is a theme or a local package; now it's a flat
dump of every installed package specifier

- For local packages the full path is shown instead

- I want  to add a `--tree`  option in to display  packages in a
tree-like format in the future

- `ls-remote` has been removed as there is no longer a preferred
organization to  look for packages— there  is no plan to  add it
back

UPDATING

-  A new  `self-update` command  has been  introduced to  update
fisher itself

- fisher  will be only  updated when  a new version  is actually
available

- `update` has been removed

-  Everything is  installed from  scratch everytime  you add  or
remove  something,  so  there  is no  need  to  update  specific
packages—you're always up-to-date

-  To  lock  on  a  specific  package  version  install  from  a
tag/branch, e.g., `mypkg/foobar@1.3.2`

UNINSTALLING

- `self-uninstall` works as usual

HELP & VERSION

- `help` only displays fisher usage help

- help is dumped to stdout instead of creating a man page on the
fly and piping it to your pager `version` works as usual

ENVIRONMENT

- `$fish_path` been  renamed to `$fisher_path` to  make it clear
that this is a fisher specific extension, not your shell's

ECOSYSTEM

-  Oh  My  Fish!  packages  are  still  supported,  albeit  less
attention is paid to them

-  Some  packages that  use  Oh  My Fish!  specific  environment
variables or events might not work

- Most of  Oh My Fish! extensions are no  longer necessary since
fish 2.3, therefore it should be a simple matter to upgrade them
to modern fish

DEPENDENCIES

- fisher can now run on fish 2.0

- It's a  good idea to upgrade  to at least fish 2.3  to use the
string builtin and configuration snippets, but there's no reason
for fisher to force you to use any fish version

- `curl` is required for fetching packages

- I am considering adding a  fallback to `wget` if `curl` is not
available on your system

- `git` is optional

-  V3   fetches  packages  directly  from   github,  gitlab  and
bitbucket, if you are using them

- git  is only used  (implementation still  wip) if you  want to
install a  package from an  unknown git  host like your  own git
server
 2018-10-05 20:20:31 +09:00
Jorge Bucaran d265de6ef6
refactor: remove slack button 2018-09-09 17:16:41 +09:00
Jorge Bucaran 0a9d7faa8b
docs: add heading 2018-09-07 20:18:58 +09:00
Jorge Bucaran dadcc6c190
docs: add bootstrap note; fix #420 2018-09-07 20:17:02 +09:00
Jorge Bucaran f96c314497
style: remove fisherman logo from README; too large and obnoxious 2018-09-07 18:26:01 +09:00
Dror Levin 8c2c9e1a92 Fix config.fish example for custom paths (#433) 
The `fish_function_path` must be set before sourcing the `conf.d` files because they might call functions in that path.
 2018-09-05 21:32:08 +09:00
Patrick 196850e09a Add fisherman logo to readme (#436) 2018-07-23 01:05:13 +02:00
Georgy Yakovlev d3b3f6a8e4 2> /dev/null in README 2018-05-16 16:58:33 -07:00
Ryan Sullivan 766bd093a1 Allow for copy instead of linking (#401) 
* Allow for optional copy on install instead of linking

* Remove eval in favor of proper test call

* Document fisher_copy variable

* Missing ?
 2018-04-25 11:18:42 +09:00
Peeyush Kushwaha 63c59119a6 Add info about generating github token in README 
Closes #414
 2018-04-08 22:25:20 -07:00
Joe Green 79fc2e6f6b fisher up obeys $fish_path (#407) 
* Ensure fisherman's completions are placed in the correct fisherman directory when running self update.

* Update documentation to include the extra steps required when setting fish_path.

* -U instead of -g in README.
 2017-12-13 19:29:58 +09:00
Jorge Bucaran 9617f27ee3
Add https to URL. 2017-06-19 18:20:34 +09:00
Jorge Bucaran 0f003c0ce1
Add info to the README about how to contribute to the project. 2017-05-22 09:14:06 +09:00
Jorge Bucaran 98ad0d10c4
Update README.md 2017-05-13 22:57:05 +09:00
Jorge Bucaran ba3dd33269
Emphasize fishfile. 2017-02-18 15:33:14 +09:00
Francisco Lourenco e15ccc8f75 Document how to install branches and tags 
Closes: #364
 2017-02-15 21:36:03 +01:00
Jorge Bucaran f359fa1c51
Fisherman is concurrent (fetch/update), let's make this more prominent. 2017-02-15 16:39:26 +09:00
Jorge Bucaran 92716f334b
Use https. 2017-02-02 00:46:26 +09:00
Jorge Bucaran 742c2cad3f
Update home page URL. 2017-01-21 17:29:22 +09:00
Jorge Bucaran 32d569b5c9
Move badges. 2017-01-20 19:29:30 +09:00
Jorge Bucaran 42c2aa993d
Make fake path more realistic. 2017-01-04 20:00:35 +09:00
Jorge Bucaran 7f8cd6afa9
Make command examples consistent. 2017-01-04 19:59:24 +09:00
Jorge Bucaran 328d742f30
Improve instructions. 2017-01-04 19:57:28 +09:00
Mert ec6c2c4720 Add Turkish translation (#355) 2016-12-02 20:52:51 +09:00
Lorenzo Manacorda 8e57d3744d Explain ls-remote --format option 
Add example of using `ls-remote --format` to display additional info about available plugins.
 2016-11-19 17:08:44 +01:00
Édouard Lopez 008926efc3 add French translation 2016-11-04 18:25:47 +01:00
Jorge Bucaran fe9d45df8b
Update README.md 2016-09-15 11:02:20 +09:00
David Liu 551cdc98f8 Add traditional chinese to wiki 2016-08-20 04:51:44 +08:00
Jorge Bucaran 539dd5bd6a
Update README.md 2016-07-24 00:17:47 +09:00
Jorge Bucaran 49377ba3d7
Update FAQ. 2016-07-19 11:44:23 +09:00
Jorge Bucaran 7c624c1369
Simplify. 2016-07-09 10:49:16 +09:00
Ian Ferguson abddf33f46 Add FAQ for resolving github api token issues 2016-06-10 08:47:24 -04:00
Jorge Bucaran d57bee59ce
Provide more useful instructions that won't leave newbies scratching their head. 2016-06-04 10:59:07 +09:00
Jorge Bucaran 57c859424f
Fix instructions to point to new git.io link. 2016-06-01 07:13:29 +09:00
Jorge Bucaran cde155debd
Introduce fish_path. Fix #301. 2016-05-28 18:09:53 +09:00
Jorge Bucaran 2cb3b58538
Update install instructions. 2016-05-27 20:41:48 +09:00
Jorge Bucaran 655785fac6
Remove brew tap install instructions. 2016-05-27 20:41:08 +09:00
Sajjad Hashemian 4d6b8a1485 Add Persian translation 🇮🇷 (#299) 2016-05-26 22:18:07 +04:30
Jorge Bucaran f129b655d5
Fix typo in install url. 2016-05-27 01:55:40 +09:00
Jorge Bucaran 3f79861722
Better uninstall support, help completions, etc. 
* #293, #294
 2016-05-27 01:41:26 +09:00
Jorge Bucaran 0fbdd1f15f
Less words, edits. 2016-05-27 00:34:24 +09:00
jona bba611d39a Add German translation 🇩🇪 (#295) 2016-05-25 02:02:24 +09:00
Jorge Bucaran a11c1a9a95
Add brew install instructions. 2016-05-22 03:46:55 +09:00
Jorge Bucaran d3dbe2624d
Remove docs directory. 
* Move translations to the wiki to encourage anyone to contribute
  without going through a full PR.
 2016-05-21 18:07:37 +09:00
Jorge Bucaran 7259a3ee6a
Introduce $fisher_cmd_name variable to customize fisher command name. 2016-05-19 18:47:40 +09:00
Jorge Bucaran 88b401efa6
Update real rename to sol. 2016-05-18 02:48:02 +09:00
Alexey Alekhin dbb207bb85 Updated 🇷🇺 docs (#282) 2016-05-15 15:09:38 +02:00
Jorge Bucaran 59000414e8
Docs. 2016-05-14 14:17:27 +09:00
Jorge Bucaran d1d50cd2e0
Words. 2016-05-12 20:52:09 +09:00
Jorge Bucaran be827c7b8e
Simplify, remove hard to maintain numbers. 2016-05-07 19:12:59 +09:00
Jorge Bucaran 50fb646b34
Words. 2016-05-07 04:20:55 +09:00
Jorge Bucaran d31d68daeb
Words. 2016-05-06 01:22:52 +09:00
Jorge Bucaran f1f35048b4
Use more meaningful url in examples. 2016-05-03 03:02:48 +09:00
Jorge Bucaran 979f67344e
Make fishfile a link instead of duplicating FAQ question. 2016-05-03 02:48:48 +09:00
Jorge Bucaran 6df88ca8e1
Remove links to other translations inside translations. 2016-05-02 02:12:56 +09:00
Jorge Bucaran 05abdbb705
Instructions. 2016-05-02 01:54:19 +09:00
Fábio Antunes f9a954648d Add Portuguese translation ⚽ (#240) 
* Add Portuguese translation.

* Added Portuguese to the other languages.
 2016-04-30 02:46:12 +09:00
Jorge Bucaran bb7fbea901
Fix broken link to fish-shell. 2016-04-29 20:10:36 +09:00
Jorge Bucaran 5b91e3f4fe
Remove uninstall instructions via npm. 2016-04-29 18:11:41 +09:00
Jorge Bucaran 19fcc31912
Remove 1.5 upgrade instructions from README. 2016-04-29 17:37:20 +09:00
Jorge Bucaran cf01ee0843
Remove npm install instructions from README. 2016-04-29 17:36:43 +09:00
Jorge Bucaran c717aad401
Put back link to fish-shell. 2016-04-29 17:33:25 +09:00
Jorge Bucaran 3e1f2f7c66
Add usage instructions for ls-remote + other tweaks. 2016-04-29 04:21:58 +09:00
Jorge Bucaran 476a6988dc
Improve usage examples. 2016-04-28 01:11:48 +09:00
Jorge Bucaran df94db62dd
Bump to 2.1.11 📦 2016-04-27 01:22:53 +09:00
Markcial 52eb9a71fd Added missing link to catalan docs to the main README file 2016-04-25 21:09:17 +02:00
Markcial c2d0b59a04 Added missing link to catalan docs to the main README file 2016-04-25 21:08:12 +02:00
Jorge Bucaran 4f9d628a9e
Add note about upgrading from 1.5. Thanks @laughedelic. 2016-04-26 02:11:51 +09:00
Jorge Bucaran ee6a805ef6
Fix broken links in docs. 2016-04-25 16:53:04 +09:00
Jorge Bucaran 133055b926
Simplify FAQ more, no one is asking those questions. 2016-04-24 02:27:13 +09:00
Jorge Bucaran d729c88567
Use slack badge with live status. 2016-04-24 02:24:39 +09:00
Jorge Bucaran eef50fcd09
Add uninstall instructions, update docs. 2016-04-24 01:33:34 +09:00
Jorge Bucaran fd7374f212
Update npm install instructions to use `-g`. 2016-04-24 01:13:37 +09:00
Jorge Bucaran 1c80de4d47
Correct npm install instructions 📦. 2016-04-24 01:00:32 +09:00
Jorge Bucaran e977175f2c
Add npm install instructions. 2016-04-23 22:20:53 +09:00
Denis Denisov 9c1464fdb0 Add Russian docs for 2.0 (#209) 2016-04-23 17:34:24 +09:00
Jorge Bucaran 948f815980
Reword FAQ#1 question. 2016-04-23 15:46:57 +09:00
Jorge Bucaran 5456f1994c
Remove another useless question from FAQ. 2016-04-23 15:44:15 +09:00
Jorge Bucaran ab87449286
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.
 2016-04-23 15:33:09 +09:00
Jorge Bucaran a6ece19067
Fix more broken links in docs 💐 2016-04-23 14:34:29 +09:00
Jorge Bucaran 9fcbd560d8
Fix broken links in docs. 2016-04-23 14:32:01 +09:00
Jorge Bucaran 9047bde4ac
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.
 2016-04-23 14:23:30 +09:00