extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2024-11-22 08:14:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Small doc touch-ups (#176)

Browse Source
This commit is contained in:
Matan Kushner 2019-08-17 16:38:20 -04:00 committed by GitHub
parent 421d22ed5c
commit 7475c3dd72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -40,7 +40,6 @@
<h1></h1> <h1></h1>
Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br> Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br>
The prompt shows information you need while you're working, while staying sleek and out of the way. The prompt shows information you need while you're working, while staying sleek and out of the way.
@ -57,7 +56,10 @@ The prompt shows information you need while you're working, while staying sleek
- Current Ruby version (`💎`). - Current Ruby version (`💎`).
- Current Python version (`🐍`) - Current Python version (`🐍`)
- Current Go version (`🐹`) - Current Go version (`🐹`)
- Package version of package in current directory (`📦`) - Current version of package in current directory (`📦`)
- npm (Node.js)
- cargo (Rust)
- poetry (Python)
- Current battery level and status - Current battery level and status
- Current Git branch and rich repo status: - Current Git branch and rich repo status:
- `=` — conflicting changes - `=` — conflicting changes
@ -99,35 +101,35 @@ The prompt shows information you need while you're working, while staying sleek
1. Add the init script to your shell's config file: 1. Add the init script to your shell's config file:
#### Bash #### Bash
Add the following to the end of `~/.bashrc`: Add the following to the end of `~/.bashrc`:
```sh ```sh
# ~/.bashrc # ~/.bashrc
eval "$(starship init bash)" eval "$(starship init bash)"
``` ```
#### Fish #### Fish
Add the following to the end of `~/.config/fish/config.fish`: Add the following to the end of `~/.config/fish/config.fish`:
```sh ```sh
# ~/.config/fish/config.fish # ~/.config/fish/config.fish
eval (starship init fish) eval (starship init fish)
``` ```
#### Zsh #### Zsh
Add the following to the end of `~/.zshrc`: Add the following to the end of `~/.zshrc`:
```sh ```sh
# ~/.zshrc # ~/.zshrc
eval "$(starship init zsh)" eval "$(starship init zsh)"
``` ```
## 🔧 Configuration ## 🔧 Configuration

40
docs/config/README.md
View File

@ -89,19 +89,19 @@ discharging_symbol = "💀"
The `character` module shows a character (usually an arrow) beside where the text The `character` module shows a character (usually an arrow) beside where the text
is entered in your terminal. is entered in your terminal.
The character will tell you whether the last command was successful or not. It The character will tell you whether the last command was successful or not. It
can do this in two ways: by changing color (red/green) or by changing its shape can do this in two ways: by changing color (red/green) or by changing its shape
(➜/✖). The latter will only be done if `use_symbol_for_status` is set to `true`. (➜/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------- | ---------------------------------------------------- | | ----------------------- | ------- | --------------------------------------------------------------------------------- |
| `symbol` | `"➜"` | The symbol used before the text input in the prompt. | | `symbol` | `"➜"` | The symbol used before the text input in the prompt. |
| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. | | `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. | | `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if zsh is in vim normal mode. | | `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if zsh is in vim normal mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
### Example ### Example
@ -120,14 +120,14 @@ The `cmd_duration` module shows how long the last command took to execute.
The module will be shown only if the command took longer than two seconds, or The module will be shown only if the command took longer than two seconds, or
the `min_time` config value, if it exists. the `min_time` config value, if it exists.
::: warning Do Not Hook the DEBUG trap in Bash ::: warning Do not hook the DEBUG trap in Bash
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running If you are running Starship in `bash`, do not hook the `DEBUG` trap after running
`eval $(starship init $0)`, or this module **will** break. `eval $(starship init $0)`, or this module **will** break.
::: :::
Bash users who need preexec-like functionality can use Bash users who need preexec-like functionality can use
[rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec).
Simply define the arrays `preexec_functions` and `precmd_functions` before Simply define the arrays `preexec_functions` and `precmd_functions` before
running `eval $(starship init $0)`, and then proceed as normal. running `eval $(starship init $0)`, and then proceed as normal.
### Options ### Options
@ -309,9 +309,9 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------- | -------------------------------------------------------- | | ---------- | ------- | --------------------------- |
| `disabled` | `false` | Disables the `ruby` module. | | `disabled` | `false` | Disables the `ruby` module. |
### Example ### Example
@ -398,13 +398,12 @@ The module will be shown if any of the following conditions are met:
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ------- | -------------------------------------------------------- | | -------------------- | ---------- | --------------------------------------------------------------------------- |
| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. | | `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. |
| `disabled` | `false` | Disables the `python` module. | | `disabled` | `false` | Disables the `python` module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) | | `pyenv_prefix` | `"pyenv "` | Prefix before pyenv version display (default display is `pyenv MY_VERSION`) |
### Example ### Example
@ -464,4 +463,3 @@ The module will be shown if any of the following conditions are met:
[username] [username]
disabled = true disabled = true
``` ```