IlanCosman/tide
1
1
Fork 0
mirror of https://github.com/IlanCosman/tide.git synced 2024-12-02 11:49:08 +03:00
Code Issues Projects Releases Wiki Activity

Convert all links to reference links

Browse Source
This commit is contained in:
Ilan Cosman 2020-06-15 19:48:51 -07:00
parent c658838956
commit 37898fe0e3
1 changed files with 28 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,8 +1,8 @@
# 🌊 Tide [![release_shield]][releases] [![fish_version_shield]](#System-Requirements) [![license_shield]][license] # 🌊 Tide [![release_shield]][releases] [![fish_version_shield]](#System-Requirements) [![license_shield]][license]
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. Tide is a [Fish] theme inspired by [Powerlevel10k]. It aims to provide a powerful, flexible, and out-of-the-box experience.
![Prompt_Connection](/media/images/Prompt_Connection.png) ![Prompt_Connection]
# Installation # Installation
@ -17,7 +17,7 @@ Tide is a [Fish] theme inspired by [Powerlevel10k](https://github.com/romkatv/po
### System Requirements ### System Requirements
- [fish] ≥3.1 - [fish] ≥3.1
- [git](https://github.com/git/git) - [git]
# Features # Features
@ -25,19 +25,19 @@ Tide is a [Fish] theme inspired by [Powerlevel10k](https://github.com/romkatv/po
Type `tide configure` to open the the wizard in your terminal. Type `tide configure` to open the the wizard in your terminal.
![Configuration_Wizard](/media/gifs/Configuration_Wizard.gif) ![Configuration_Wizard]
### Multi-Line Right Prompt ### Multi-Line Right Prompt
> Fish can't do _that_ yet can it? > Fish can't do _that_ yet can it?
![Multi-Line_Right_Prompt](/media/images/Multi-Line_Right_Prompt.png) ![Multi-Line_Right_Prompt]
### Pure Compatibility ### Pure Compatibility
Tide can produce the same prompt as [Pure](https://github.com/rafaelrinaldi/pure). Type `tide configure` and select the Pure style. Tide can produce the same prompt as [Pure]. Type `tide configure` and select the Pure style.
![Pure_Compatibility](/media/gifs/Pure_Compatibility.gif) ![Pure_Compatibility]
Tide doesn't recognize Pure configuration parameters, so you'll need to use `tide_cmd_duration_threshold=3000` instead of `pure_threshold_command_duration=3`, etc. Tide doesn't recognize Pure configuration parameters, so you'll need to use `tide_cmd_duration_threshold=3000` instead of `pure_threshold_command_duration=3`, etc.
@ -45,11 +45,11 @@ Tide doesn't recognize Pure configuration parameters, so you'll need to use `tid
If there isn't a prompt item that fits your needs, make your own! If there isn't a prompt item that fits your needs, make your own!
![Extensible](/media/images/Extensible.png) ![Extensible]
# Contributing # Contributing
If you're interested in helping contribute to Tide, please take a look at the [Contributing Guide](https://github.com/IlanCosman/tide/blob/master/CONTRIBUTING.md). If you're interested in helping contribute to Tide, please take a look at the [Contributing Guide][contributing_guide].
# Configuration # Configuration
@ -100,7 +100,7 @@ Tide variables that users are encouraged to modify begin with the string `tide_`
### git_prompt ### 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 inherited from fish's built-in [fish_git_prompt]. Modify those variables to configure tide's git prompt.
### jobs ### jobs
@ -153,21 +153,30 @@ Tide's git capabilities are inherited from fish's built-in [fish_git_prompt](htt
Download these four ttf files: Download these four ttf files:
- [Sauce Code Pro Regular.ttf] - [Sauce Code Pro Regular.ttf][sauce_code_pro_regular.ttf]
- [Sauce Code Pro Bold.ttf] - [Sauce Code Pro Bold.ttf][sauce_code_pro_bold.ttf]
- [Sauce Code Pro Italic.ttf] - [Sauce Code Pro Italic.ttf][sauce_code_pro_italic.ttf]
- [Sauce Code Pro Bold-Italic.ttf] - [Sauce Code Pro Bold-Italic.ttf][sauce_code_pro_bold-italic.ttf]
Open each file and click "Install". This will make the `Sauce Code Pro` font available to all applications on your system. Configure your terminal to use this font. Open each file and click "Install". This will make the `Sauce Code Pro` font available to all applications on your system. Configure your terminal to use this font.
[reference links]: ----------------------------------------------------------------------------------------------------
[release_shield]: https://img.shields.io/github/v/release/IlanCosman/tide?label=%20 [release_shield]: https://img.shields.io/github/v/release/IlanCosman/tide?label=%20
[releases]: https://github.com/IlanCosman/tide/releases [releases]: https://github.com/IlanCosman/tide/releases
[fish_version_shield]: https://img.shields.io/badge/fish-3.1.0%2B-blue [fish_version_shield]: https://img.shields.io/badge/fish-3.1.0%2B-blue
[license_shield]: https://img.shields.io/github/license/IlanCosman/tide [license_shield]: https://img.shields.io/github/license/IlanCosman/tide
[license]: https://github.com/IlanCosman/tide/blob/master/LICENSE [license]: https://github.com/IlanCosman/tide/blob/master/LICENSE
[fish]: https://github.com/fish-shell/fish-shell [fish]: https://github.com/fish-shell/fish-shell
[sauce code pro regular.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Regular/complete/Sauce%20Code%20Pro%20Nerd%20Font%20Complete.ttf [powerlevel10k]: https://github.com/romkatv/powerlevel10k/
[sauce code pro bold.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Bold/complete/Sauce%20Code%20Pro%20Bold%20Nerd%20Font%20Complete.ttf [prompt_connection]: /media/images/Prompt_Connection.png
[sauce code pro italic.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Italic/complete/Sauce%20Code%20Pro%20Italic%20Nerd%20Font%20Complete.ttf [git]: (https://github.com/git/git)
[sauce code pro bold-italic.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Bold-Italic/complete/Sauce%20Code%20Pro%20Bold%20Italic%20Nerd%20Font%20Complete.ttf [configuration_wizard]: /media/gifs/Configuration_Wizard.gif
[multi-line_right_prompt]: /media/images/Multi-Line_Right_Prompt.png
[pure]: https://github.com/rafaelrinaldi/pure
[pure_compatibility]: /media/gifs/Pure_Compatibility.gif
[extensible]: /media/images/Extensible.png
[contributing_guide]: https://github.com/IlanCosman/tide/blob/master/CONTRIBUTING.md
[fish_git_prompt]: https://fishshell.com/docs/current/cmds/fish_git_prompt.html
[sauce_code_pro_regular.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Regular/complete/Sauce%20Code%20Pro%20Nerd%20Font%20Complete.ttf
[sauce_code_pro_bold.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Bold/complete/Sauce%20Code%20Pro%20Bold%20Nerd%20Font%20Complete.ttf
[sauce_code_pro_italic.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Italic/complete/Sauce%20Code%20Pro%20Italic%20Nerd%20Font%20Complete.ttf
[sauce_code_pro_bold-italic.ttf]: https://github.com/ryanoasis/nerd-fonts/raw/master/patched-fonts/SourceCodePro/Bold-Italic/complete/Sauce%20Code%20Pro%20Bold%20Italic%20Nerd%20Font%20Complete.ttf