Work on README

This commit is contained in:
Ilan Cosman 2020-05-19 18:08:57 -07:00
parent 26683bdc70
commit 37b241337f
5 changed files with 34 additions and 13 deletions

View File

@ -1,6 +1,6 @@
# Tide ![Fish_Version_Shield](https://img.shields.io/badge/fish-3.1.0-blue)
A Fish theme based on [Powerlevel10k](https://github.com/romkatv/powerlevel10k/).
Tide is a Fish theme inspired by [Powerlevel10k](https://github.com/romkatv/powerlevel10k/). It aims to provide a powerful, flexible, and out-of-the-box experience.
![Prompt_Connection](/media/images/Prompt_Connection.png)
@ -14,11 +14,29 @@ curl -s https://raw.githubusercontent.com/IlanCosman/tide/master/install.fish |
# Features
- Reactive superior prompt character ``
- Current directory, shortened according to terminal width
- Git branch and status information
- Configuration wizard
- Right Prompt Items:
## Multi-Line Right Prompt
> Fish cant do _that_ yet can it?
![Multiple_Line_Right_Prompt](/media/images/Multiple_Line_Right_Prompt.png)
## Configuration Wizard
Type `tide configure` to open the the wizard in your terminal.
![Configuration_Wizard](/media/gifs/Configuration_Wizard.gif)
## Extensible
If there isn't a prompt item that fits your needs, make your own!
![Extensible](/media/images/Extensible.png)
# Configuration
Note that all tide variables, unless stated otherwise, begin with the string `tide_`. Thus, for brevity, variables in this section will be denoted as `example_variable` but will actually be `tide_example_variable`.
## Prompt Items
| Item | Display |
| :----------: | ------------------------------------- |
@ -28,12 +46,6 @@ curl -s https://raw.githubusercontent.com/IlanCosman/tide/master/install.fish |
| jobs | presence of background jobs |
| time | current time |
# Configuration
Note that all tide variables, unless stated otherwise, begin with the string `tide_`. Thus, for brevity, variables in this section will be denoted as `example_variable` but will actually be `tide_example_variable`.
## Prompt Items
### pwd
| Variable | Description | Default |
@ -43,7 +55,7 @@ Note that all tide variables, unless stated otherwise, begin with the string `ti
### git prompt
Tide's git capabilities are inherited from fish's built-in [fish_git_prompt](https://fishshell.com/docs/current/cmds/fish_git_prompt.html). Modify those variables to configure tide's git prompt.
Tide's git capabilities are currently inherited from fish's built-in [fish_git_prompt](https://fishshell.com/docs/current/cmds/fish_git_prompt.html). Modify those variables to configure tide's git prompt.
### prompt connection

9
gif.fish Normal file
View File

@ -0,0 +1,9 @@
set -U tide_right_prompt_items 'status' 'jobs'
clear
Start recording
echo $tide_right_prompt_items
ssh localhost
awd123mnl4562
sleep 60 &
set -U tide_right_prompt_items 'status' 'jobs' 'context'
set -U tide_right_prompt_items 'status' 'jobs' 'newline' 'context'

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

BIN
media/images/Extensible.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB