-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from guesswhozzz/readme
docs: update readme to 2.0 version
- Loading branch information
Showing
1 changed file
with
48 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,79 @@ | ||
# 021011.zsh-theme — prompt settings for zsh | ||
# 021011.zsh-theme — theme and settings for Z shell | ||
|
||
#### 021011.zsh-theme is a selection of settings that'll bring the shell and the workspace into one | ||
## **Preview** | ||
|
||
![item zsh prompt](https://github.com/guesswhozzz/guezwhoz-scheme/blob/main/demos/zsh-theme-demo-min.png?raw=true) | ||
|
||
--- | ||
|
||
## Installation | ||
## **Overview** | ||
### Theme includes prompt settings, vsc_info settings, and zsh completion settings | ||
### **Prompt** | ||
|
||
Essentially, the shell prompt is split into three separate lines. The first line helps to visually | ||
divide the previous output from the next prompt. The second line consists of three **segments** and contains all about path. The third is the input line. | ||
|
||
### **Path segments** | ||
|
||
**Install using Git** | ||
- **ssh connection** - The badge indicates whether the ssh connection is currently established | ||
- **directory** - Current working directory | ||
- **vsc status line** - This segment displays current branch status in the working directory | ||
|
||
1. Cloning the repo | ||
### **Completion** | ||
|
||
Includes completion menu and style settings, caching, setting for ssh host and name suggestion, | ||
and many other useful settings. | ||
|
||
--- | ||
|
||
## **Installation** | ||
|
||
_For Installation you need git_ | ||
|
||
### **Manual** | ||
|
||
1. Clone the repository: | ||
|
||
```shell | ||
% git clone https://github.com/guesswhozzz/021011.zsh-theme ~/021011-tools | ||
git clone https://github.com/guesswhozzz/021011.zsh-theme ~/021011-tools | ||
``` | ||
|
||
2. Creating a symbolic link to oh-my-zsh's theme folder | ||
2. Update your .zshrc file: | ||
|
||
```shell | ||
% ln -s ~/021011-tools/021011.zsh-theme $ZSH/themes/021011.zsh-theme | ||
echo 'source ~/021011-tools/021011.zsh-theme' >> ~/.zshrc | ||
``` | ||
|
||
3. Go to your `~/.zshrc` file and set `ZSH_THEME=021011` | ||
### **Oh My Zsh** | ||
|
||
--- | ||
1. Clone the repository: | ||
|
||
## Preview | ||
```shell | ||
git clone https://github.com/guesswhozzz/021011.zsh-theme ~/021011-tools | ||
``` | ||
|
||
![item zsh prompt](https://github.com/guesswhozzz/guezwhoz-scheme/blob/main/demos/zsh-theme-demo-min.png?raw=true) | ||
2. Move file to oh-my-zsh's theme folder: | ||
|
||
--- | ||
```shell | ||
mv ~/021011-tools/021011.zsh-theme $ZSH/themes/021011.zsh-theme | ||
``` | ||
|
||
## Main feature | ||
3. Go to your `~/.zshrc` file and set `ZSH_THEME=021011` | ||
|
||
- Single git status marker for Visual Studio Code and Git cli | ||
- Interactive `Tab` completer | ||
--- | ||
|
||
## Recommended Settings | ||
## **Recommended Settings** | ||
|
||
- [Color scheme for term](https://github.com/guesswhozzz/guezwhoz-scheme/blob/main/color-scheme/guezwhoz-scheme.yaml) | ||
|
||
> Mac Os users can set color scheme for iTerm2 from [repo](https://github.com/guesswhozzz/guezwhoz-iterm2-theme) | ||
|
||
--- | ||
## Extra | ||
|
||
## **Extra** | ||
|
||
You can find this color scheme for other terminal emulators in the [mbadolato](https://github.com/mbadolato/iTerm2-Color-Schemes) color scheme repository | ||
|
||
--- | ||
|
||
License [MIT](https://github.com/guesswhozzz/guezwhoz-vscode-theme/blob/master/LICENSE) © [Egor Lem](https://github.com/guesswhozzz) |