mirror of
https://github.com/IlanCosman/tide.git
synced 2024-11-27 13:18:02 +03:00
Add logo, remove configuration section
This commit is contained in:
Ilan Cosman
parent
46abf0472d
commit
d1408aa95e
121
README.md
121
README.md
@ -1,4 +1,18 @@
|
||||
# 🌊 Tide [![ci_badge][]][actions] [![fish_version_badge][]](#System-Requirements) [![license_badge][]][license]
|
||||
<div align="center">
|
||||
|
||||
<img
|
||||
src="https://raw.githubusercontent.com/IlanCosman/tide-resources/master/images/logo.svg"
|
||||
alt="Multi-Line_Right_Prompt.png"
|
||||
width="400"
|
||||
/>
|
||||
|
||||
<!-- 0 width spaces on the line below -->
|
||||
|
||||
[![ci_badge][]][actions] [![fish_version_badge][]](#System-Requirements) [![license_badge][]][license]
|
||||
|
||||
</div>
|
||||
|
||||
#
|
||||
|
||||
Tide is a [Fish][] theme that provides a powerful, flexible, and out-of-the-box experience.
|
||||
|
||||
@ -53,109 +67,6 @@ If there isn't a prompt item that fits your needs, make your own!
|
||||
|
||||
If you're interested in helping contribute to Tide, please take a look at the [Contributing Guide][].
|
||||
|
||||
## Configuration
|
||||
|
||||
Tide variables that users are encouraged to modify begin with the string `tide_`. Thus, variables in this section will be denoted as `example_variable` but will actually be `tide_example_variable`.
|
||||
|
||||
## General Variables
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ------------------ | ------------------------------------------ | -------------------------------------------- |
|
||||
| newline | add empty line before each prompt | true |
|
||||
| left_prompt_items | order of the left prompt items to display | pwd git_prompt newline prompt_char |
|
||||
| right_prompt_items | order of the right prompt items to display | status cmd_duration context jobs virtual_env |
|
||||
|
||||
### prompt_connection
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ----------------------- | --------------------------------------------------------------------- | ------- |
|
||||
| prompt_connection_color | color of prompt connection | 6C6C6C |
|
||||
| prompt_connection_icon | repeated symbol that spans gap between left and right sides of prompt | ' ' |
|
||||
|
||||
## Prompt Items
|
||||
|
||||
| Item | Description |
|
||||
| ----------------------------- | -------------------------------- |
|
||||
| [cmd_duration](#cmd_duration) | duration of the last run command |
|
||||
| [context](#context) | user@hostname in ssh or root |
|
||||
| [git_prompt](#git_prompt) | git repository status |
|
||||
| [jobs](#jobs) | presence of background jobs |
|
||||
| [prompt_char](#prompt_char) | prompt symbol;turns red on error |
|
||||
| [pwd](#pwd) | current directory |
|
||||
| [status](#status) | exit code of the last command |
|
||||
| [time](#time) | current time |
|
||||
| [virtual_env](#virtual_env) | python virtual environment |
|
||||
|
||||
### cmd_duration
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ---------------------- | ------------------------------------------------------------------ | ------- |
|
||||
| cmd_duration_color | color of cmd_duration output | 87875F |
|
||||
| cmd_duration_decimals | number of decimals to display after seconds place | 0 |
|
||||
| cmd_duration_threshold | number of milliseconds that duration must exceed to produce output | 3000 |
|
||||
|
||||
### context
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ------------------ | ------------------------------- | ------- |
|
||||
| context_root_color | color of context when root user | D7AF00 |
|
||||
| context_ssh_color | color of context when in SSH | D7AF87 |
|
||||
|
||||
### git_prompt
|
||||
|
||||
Tide's git capabilities are inherited from fish's built-in [fish_git_prompt][]. Modify those variables to configure tide's git prompt.
|
||||
|
||||
### jobs
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ---------- | ------------------------------------------------ | ------- |
|
||||
| jobs_color | color of jobs icon | D7AF00 |
|
||||
| jobs_icon | symbol to display when there are background jobs | '' |
|
||||
|
||||
### prompt_char
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ------------------------- | ----------------------------------------------------- | ------- |
|
||||
| prompt_char_icon | prompt char symbol | '❯' |
|
||||
| prompt_char_success_color | color of prompt char when last command was successful | 5FD700 |
|
||||
| prompt_char_failure_color | color of prompt char when last command failed | FF0000 |
|
||||
|
||||
### pwd
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ------------------------ | ----------------------------------------------------------------- | -------------------- |
|
||||
| pwd_anchors | Directories displayed in bold and immune to truncation | 'first' 'last' 'git' |
|
||||
| pwd_color_anchors | color of anchors | 00AFFF |
|
||||
| pwd_truncate_margin | start truncating when pwd is this many columns from terminal edge | 10 |
|
||||
| pwd_color_truncated_dirs | color of truncated directories | 8787AF |
|
||||
| pwd_max_dirs | max number of directories to display, 0 or less equals unlimited | 0 |
|
||||
| pwd_color_dirs | color of normal directories | 0087AF |
|
||||
| pwd_unwritable_icon | symbol to display when the directory is not writable by the user | '' |
|
||||
|
||||
### status
|
||||
|
||||
| Variable | Description | Default |
|
||||
| -------------------- | -------------------------------------------------------------- | ------- |
|
||||
| status_success_icon | symbol to display when the last command in a pipeline succeeds | '✔' |
|
||||
| status_success_color | color of successful pipeline's status | 5FAF00 |
|
||||
| status_failure_icon | symbol to display when the last command in a pipeline fails | '✘' |
|
||||
| status_failure_color | color of failed pipeline's status | D70000 |
|
||||
|
||||
### time
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ----------- | ---------------------- | ------- |
|
||||
| time_color | color of time display | 5F8787 |
|
||||
| time_format | format of time display | '%T' |
|
||||
|
||||
### virtual_env
|
||||
|
||||
| Variable | Description | Default |
|
||||
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|
||||
| virtual_env_color | color of virtual_env item | 00AFAF |
|
||||
| virtual_env_icon | icon to display in front of virtual_env item | '' |
|
||||
| virtual_env_display | Options are venvName and projectName. venvName is the virtual env directory, most often .venv. projectName is the directory above that | projectName |
|
||||
|
||||
## Fonts
|
||||
|
||||
### Meslo Nerd Font
|
||||
@ -175,7 +86,7 @@ Open each file and click "Install". This will make the `MesloLGS NF` font availa
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- [Powerlevel10k][] - Much of Tide's documentation, resources, ideas, and design elements are borrowed from Powerlevel10k.
|
||||
Much of Tide's documentation, resources, ideas, and design elements are borrowed from [Powerlevel10k][].
|
||||
|
||||
<!-- Alphabetical Reference Links -->
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user