Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@nabsiddiqui
nabsiddiqui committed Sep 9, 2016
1 parent b6ce058 commit d20d4a2
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,37 @@ The plugin has been tested in bash, zsh and fish

More screenshots can be found in the [wiki](https://github.com/edkolev/promptline.vim/wiki/Screenshots)

#### Quick Start with airline installed
#### Quick Start for Bash/ZSH with airline installed

1. In vim `:PromptlineSnapshot ~/.shell_prompt.sh airline`
2. In bash/zsh `source ~/.shell_prompt.sh`

#### Quick Start with lightline installed
#### Quick Start for Bash/ZSH with lightline installed

1. In vim `:PromptlineSnapshot ~/.shell_prompt.sh lightline`
2. In bash/zsh `source ~/.shell_prompt.sh`

#### Quick Start
#### Quick Start for BASH/ZSH without lightline or airline installed

1. In vim `:PromptlineSnapshot ~/.shell_prompt.sh`
2. In bash/zsh `source ~/.shell_prompt.sh`

#### Quick Start for Fish:

1. In vim `:PromptlineSnapshot ~/.shell_prompt.sh [theme] [preset]`
2. Add the following to ~/.config/fish/.config.fish

```
function fish_prompt
env FISH_VERSION=$FISH_VERSION PROMPTLINE_LAST_EXIT_CODE=$status bash ~/.shell_prompt.sh left
end
function fish_right_prompt
env FISH_VERSION=$FISH_VERSION PROMPTLINE_LAST_EXIT_CODE=$status bash ~/.shell_prompt.sh right
end
```

## Usage

Create a snapshot file with default prompt.
Expand Down Expand Up @@ -70,11 +86,11 @@ For fish:
```
# in .config.fish
function fish_prompt
env FISH_VERSION=$FISH_VERSION PROMPTLINE_LAST_EXIT_CODE=$status bash ~/.promptline.sh left
env FISH_VERSION=$FISH_VERSION PROMPTLINE_LAST_EXIT_CODE=$status bash ~/.shell_prompt.sh left
end
function fish_right_prompt
env FISH_VERSION=$FISH_VERSION PROMPTLINE_LAST_EXIT_CODE=$status bash ~/.promptline.sh right
env FISH_VERSION=$FISH_VERSION PROMPTLINE_LAST_EXIT_CODE=$status bash ~/.shell_prompt.sh right
end
```

Expand Down

1 comment on commit d20d4a2

@nabsiddiqui
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added more clear information for Fish Shell(older version referenced promptline.sh which does not match the rest of the commands using shell_prompt.sh). Made clear what shell is being used for Bash/ZSH.

Please sign in to comment.