mirror of
https://github.com/jorgebucaran/fisher
synced 2024-06-28 23:01:50 +02:00
9a4f0f0650
* Improved README, added links to screencasts, updated documentation with new changes and fixed other typos and composition errors. * Removed `fisher update --cache` in favor of `fisher --cache | fisher update` and `fisher uninstall --all` in favor of `fisher --cache | fisher uninstall`. * Fisherman does not move initialization / configuration files following the convention `name`.config.fish to `$fisher_config/functions`, but to `$fisher_config/conf.d` now and evaluates each `*.config.fish` inside at shell start as usual. Closes #13. * Added `fisher --cache[=base]` option to retrieve contents in `$fisher_cache`, eliminating flaky usage of `find(1)`. Closes #11. * Fisherman now generates information about plugins installed via custom URLs. For the description, a shortened version of the URL is used. For the URL the full URL is used. For tags, the URL is fuzzily checked and tags such as _theme_, _plugin_, _config_ and _omf_ are added. The tag _orphan_ is added by default as well. Finally, the author is generated by retrieving the e-mail or username of the author of the first commit in the plugin's repository. Closes #9 and #14. * Changed `--path-in-cache` to `--translate.` This function translates an name or supported URL/URL variation into a path inside `$fisher_cache`. This allows you to treat plugins installed via custom URLs almost like regular plugins if they are installed. Closes #8. * Fixed a bug with `mktemp` failing on some systems. Closes #7. Thanks @tobywf. * Added [CODE_OF_CONDUCT][code_of_conduct]. Closes #6. * Fisherman can now unload themes within the same shell, without having to restart the session. Closes #5. * Fisherman can now load themes within the same shell, without having to restart the session using `exec fish`. Shoddy themes, for example those failing to declare global variables with the `-g` flag still require the session to be reset. See [**related**][bobthefish-19]. Closes #4. * Move `getopts` implementation to `share/getopts.awk`. Closes #3. * Support dots inside URIs in `fisher --validate`. Closes #2.
54 lines
1.7 KiB
Markdown
54 lines
1.7 KiB
Markdown
<p align="center">
|
|
<a href="http://github.com/fisherman/fisherman">
|
|
<img alt="Fisherman" width=620px src="https://cloud.githubusercontent.com/assets/8317250/10865127/daa0e138-8044-11e5-91f9-f72228974552.png">
|
|
</a>
|
|
</p>
|
|
|
|
|
|
[![Build Status][travis-badge]][travis-link]
|
|
![Fisherman Version][fisherman-version]
|
|
|
|
## About
|
|
|
|
Fisherman is a plugin manager for [fish][fish] that lets you share and reuse code, prompts and configurations easily.
|
|
|
|
Features include a flat tree structure, external self-managed database, cache system, plugin dependencies and compatibility with Oh My Fish! packages.
|
|
|
|
+ See [FAQ][faq].
|
|
+ See [Screencasts][screencasts].
|
|
|
|
|
|
## Install
|
|
|
|
```fish
|
|
git clone https://github.com/fisherman/fisherman
|
|
cd fisherman
|
|
make
|
|
fisher help
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Check out the [contribution](CONTRIBUTING.md) guidelines.
|
|
|
|
## Help
|
|
|
|
See [`fisherman(1)`][fisherman-1] and [`fisherman(7)`][fisherman-7] for usage and documentation. For support and feedback join the Gitter [room][wharf] or browse the [issues][issues].
|
|
|
|
|
|
:anchor:
|
|
|
|
|
|
<!-- Links -->
|
|
|
|
[fish]: https://github.com/fish-shell/fish-shell
|
|
[faq]: https://github.com/fisherman/fisherman/wiki/FAQ
|
|
[issues]: http://github.com/fisherman/fisherman/issues
|
|
[wharf]: https://gitter.im/fisherman/wharf
|
|
[screencasts]: https://github.com/fisherman/fisherman/wiki/Screencasts
|
|
[fisherman-1]: man/man1/fisher.md
|
|
[fisherman-7]: man/man7/fisher.md
|
|
[travis-link]: https://travis-ci.org/fisherman/fisherman
|
|
[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg?style=flat-square
|
|
[fisherman-version]: https://img.shields.io/badge/fisherman-v0.1.0-00B9FF.svg?style=flat-square
|