tide/README.md

165 lines
5.0 KiB
Markdown
Raw Normal View History

2020-07-21 00:41:09 +03:00
<div align="center">
<img
src="resources/images/logo.svg"
2020-08-25 18:25:19 +03:00
alt="logo.svg"
width="61.8%"
2020-07-21 00:41:09 +03:00
/>
2020-08-25 18:25:19 +03:00
[![ci_badge][]][actions] [![fish_version_badge][]](#System-Requirements) [![license_badge][]][license] <!-- 0 width spaces on this line -->
2020-07-21 00:41:09 +03:00
</div>
#
2020-06-07 02:05:49 +03:00
2020-07-23 05:44:12 +03:00
<img
src="resources/images/header.png"
2020-07-27 06:28:25 +03:00
alt="header.png"
2020-07-23 05:44:12 +03:00
width="50%"
align="right"
/>
**A modern prompt manager for the [Fish][] shell.**
2020-04-03 02:30:40 +03:00
2020-07-27 04:13:01 +03:00
- **Out of the box:** With four compelling styles and myriad options, you can have your out-of-the-box cake and customize it too.
2020-07-29 18:40:43 +03:00
- **Flexible:** Move content around, remove it, or add it back, all without ever touching a line of code.
2020-07-27 04:13:01 +03:00
- **Powerful:** Impress all your Fish friends with alien technologies like a multi-line right prompt.
2020-07-27 06:28:25 +03:00
- **Extensible:** Create custom content with simple fish functions that integrate seamlessly.
2020-07-23 05:44:12 +03:00
<br clear="right">
2020-05-13 06:17:03 +03:00
2020-06-16 20:03:02 +03:00
## Installation
2020-04-03 02:30:40 +03:00
2020-07-29 18:40:43 +03:00
### System Requirements
2020-04-03 02:30:40 +03:00
2020-07-23 06:55:59 +03:00
- [Git][]
2020-07-23 06:46:37 +03:00
- [Fish][] ≥ 3.1
2020-07-29 17:35:37 +03:00
- A [Nerd Font][nerd fonts] installed and enabled in your terminal (for example the [recommended font](#fonts)).
2020-11-04 22:05:41 +03:00
Install with [Fisher][]:
2020-07-23 06:46:37 +03:00
```console
2020-11-04 22:05:41 +03:00
fisher install IlanCosman/tide
2020-07-23 06:46:37 +03:00
```
2020-05-13 06:17:03 +03:00
2020-06-16 20:03:02 +03:00
## Features
2020-05-13 06:17:03 +03:00
2020-05-20 08:14:01 +03:00
### Configuration Wizard
2020-05-20 04:08:57 +03:00
2020-07-27 04:13:01 +03:00
Run `tide configure` to open the the wizard in your terminal.
2020-05-20 04:08:57 +03:00
2020-06-19 21:13:43 +03:00
![configuration_wizard][]
2020-05-20 04:08:57 +03:00
2020-07-27 04:13:01 +03:00
<br>
2020-06-10 19:18:15 +03:00
2020-07-27 04:13:01 +03:00
<img
src="resources/images/flexible.png"
2020-07-27 07:18:42 +03:00
alt="flexible.png"
width="61.8%"
2020-07-27 04:13:01 +03:00
align="left"
/>
2020-06-10 19:18:15 +03:00
2020-07-27 04:13:01 +03:00
### Flexible
2020-06-10 19:18:15 +03:00
2020-09-17 01:00:48 +03:00
Using the [`items`][] list for each side of the prompt, you have full control of which and where prompt sections display.
2020-07-27 04:13:01 +03:00
<br clear="left"><br>
<img
src="resources/images/multi-line_right_prompt.png"
2020-07-27 06:28:25 +03:00
alt="multi-line_right_prompt.png"
2020-08-10 01:43:08 +03:00
width="61.8%"
2020-07-27 04:13:01 +03:00
align="right"
/>
2020-06-16 03:52:35 +03:00
2020-07-27 04:13:01 +03:00
### Multi-Line Right Prompt
2020-06-16 03:52:35 +03:00
2020-07-27 04:13:01 +03:00
> Fish can't do _that_ yet can it!
2020-06-16 03:52:35 +03:00
2020-07-27 06:37:52 +03:00
Tide takes care of all the multi-line logic and printing for you. All you have to do is add the `newline` item.
2020-06-16 03:52:35 +03:00
2020-07-27 04:13:01 +03:00
<br clear="right"><br>
<img
src="resources/images/extensible.png"
2020-07-27 06:28:25 +03:00
alt="extensible.png"
2020-08-10 01:43:08 +03:00
width="61.8%"
2020-07-27 04:13:01 +03:00
align="left"
/>
2020-06-16 22:28:24 +03:00
2020-05-20 08:14:01 +03:00
### Extensible
2020-05-20 04:08:57 +03:00
2020-07-27 06:28:25 +03:00
If there isn't an item that fits your needs you can make your own (and hopefully submit a pull request) or ask for it to be made by opening an issue.
2020-05-20 04:08:57 +03:00
2020-07-27 04:13:01 +03:00
<br clear="left"><br>
<img
src="resources/animations/pure_emulation.gif"
2020-07-27 06:28:25 +03:00
alt="pure_emulation.gif"
2020-08-10 01:43:08 +03:00
width="61.8%"
2020-07-27 04:13:01 +03:00
align="right"
/>
### Pure Emulation
2020-07-27 06:45:41 +03:00
Tide can easily produce the same prompt as [Pure][] (with a number of improvements). Run `tide configure` and select the Pure style.
2020-07-27 04:13:01 +03:00
2020-07-27 06:45:41 +03:00
All of Tide's features are available while using Pure style, though it displays less information by default than Lean style.
2020-07-27 04:13:01 +03:00
2020-07-27 06:37:52 +03:00
<br clear="right">
2020-05-20 04:08:57 +03:00
2020-09-17 01:00:48 +03:00
## Configuration
2020-07-24 06:27:51 +03:00
2020-09-17 01:00:48 +03:00
See the [configuration guide][] for variable documentation.
2020-07-24 06:27:51 +03:00
2020-06-16 20:03:02 +03:00
## Contributing
2020-05-31 04:03:41 +03:00
2020-07-27 04:13:01 +03:00
From the smallest typo to the largest feature, contributions of any size or experience level are welcome!
If you're interested in helping contribute to Tide, please take a look at the [Contributing Guide][].
2020-05-31 04:03:41 +03:00
2020-06-16 20:03:02 +03:00
## Fonts
2020-06-05 05:43:27 +03:00
2020-07-17 05:53:34 +03:00
### Meslo Nerd Font
2020-07-18 09:17:25 +03:00
Gorgeous monospace font designed by Jim Lyles for Bitstream, customized for Apple, enhanced by André Berg, and finally patched by Roman Perepelitsa of [Powerlevel10k][] with scripts originally developed by Ryan McIntyre of [Nerd Fonts][]. Contains all the glyphs and symbols that Tide may need. Battle-tested in dozens of different terminals on all major operating systems.
2020-06-16 20:03:02 +03:00
### Font Installation
2020-06-05 05:43:27 +03:00
Download these four ttf files:
2020-07-17 05:53:34 +03:00
- [MesloLGS NF Regular.ttf][]
- [MesloLGS NF Bold.ttf][]
- [MesloLGS NF Italic.ttf][]
- [MesloLGS NF Bold Italic.ttf][]
2020-06-05 05:43:27 +03:00
2020-07-17 06:21:09 +03:00
Open each file and click "Install". This will make the `MesloLGS NF` font available to all applications on your system. Configure your terminal to use this font.
2020-07-08 21:27:41 +03:00
## Acknowledgments
2020-07-23 06:46:37 +03:00
- [Powerlevel10k][] - Inspired much of Tide's documentation, resources, ideas, and design.
2020-08-19 20:35:04 +03:00
- [Starship][] - Inspired elements of Tide's documentation and community health files.
- [Spacefish][] - Inspired some of Tide's items.
2020-09-17 01:25:33 +03:00
[`items`]: docs/Configuration.md#Items
2020-07-17 05:53:34 +03:00
[actions]: https://github.com/IlanCosman/tide/actions
2020-07-12 21:12:56 +03:00
[ci_badge]: https://github.com/IlanCosman/tide/workflows/CI/badge.svg
2020-09-17 01:00:48 +03:00
[configuration guide]: docs/Configuration.md
[configuration_wizard]: resources/animations/configuration_wizard.gif
2020-07-17 04:50:52 +03:00
[contributing guide]: CONTRIBUTING.md
2020-07-08 21:27:41 +03:00
[fish_version_badge]: https://img.shields.io/badge/fish-3.1.0%2B-blue
2020-09-07 22:00:54 +03:00
[fish]: https://fishshell.com/
2020-11-04 22:05:41 +03:00
[fisher]: https://github.com/jorgebucaran/fisher
2020-07-23 06:55:59 +03:00
[git]: https://git-scm.com/
2020-07-08 21:27:41 +03:00
[license_badge]: https://img.shields.io/github/license/IlanCosman/tide
2020-09-07 22:00:54 +03:00
[license]: LICENSE.md
2020-09-29 05:09:30 +03:00
[meslolgs nf bold italic.ttf]: https://github.com/IlanCosman/tide/raw/main/resources/fonts/mesloLGS_NF_bold_italic.ttf
[meslolgs nf bold.ttf]: https://github.com/IlanCosman/tide/raw/main/resources/fonts/mesloLGS_NF_bold.ttf
[meslolgs nf italic.ttf]: https://github.com/IlanCosman/tide/raw/main/resources/fonts/mesloLGS_NF_italic.ttf
[meslolgs nf regular.ttf]: https://github.com/IlanCosman/tide/raw/main/resources/fonts/mesloLGS_NF_regular.ttf
2020-07-17 05:53:34 +03:00
[nerd fonts]: https://github.com/ryanoasis/nerd-fonts
2020-07-08 21:27:41 +03:00
[powerlevel10k]: https://github.com/romkatv/powerlevel10k/
2020-07-06 20:15:49 +03:00
[pure]: https://github.com/rafaelrinaldi/pure
2020-08-19 20:35:04 +03:00
[spacefish]: https://github.com/matchai/spacefish
2020-07-23 06:46:37 +03:00
[starship]: https://github.com/starship/starship