diff options
author | Matan Kushner <hello@matchai.me> | 2019-12-05 13:15:21 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-12-05 13:15:21 -0500 |
commit | 5b440c0bb01b35eff1ebd92af1a2c013668fed04 (patch) | |
tree | f817fa63423e9f6f828e38d56e60c95804e3f212 /README.md | |
parent | ec54180e4291a291d57ed8168d471216a2108795 (diff) |
docs: Simplify installation process and docs (#643)
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 83 |
1 files changed, 34 insertions, 49 deletions
@@ -19,12 +19,12 @@ src="https://repology.org/badge/tiny-repos/starship.svg" alt="Packaging status"/></a ><br /> - <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --><a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-53-orange" alt="All Contributors"></a><!-- ALL-CONTRIBUTORS-BADGE:END --> - <a href="https://discord.gg/8Jzqu3T" + <a href="https://discord.gg/8Jzqu3T" ><img src="https://img.shields.io/discord/567163873606500352?logo=discord" alt="Chat on Discord" /></a> + <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --><a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-53-orange" alt="All Contributors"></a><!-- ALL-CONTRIBUTORS-BADGE:END --> </p> <h4 align="center"> @@ -39,27 +39,27 @@ <a href="https://github.com/starship/starship/blob/master/README.md" ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png" alt="English" /></a> -  + <a href="https://github.com/starship/starship/blob/master/docs/ja-JP/guide/README.md" ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png" alt="日本語" /></a> -  + <a href="https://github.com/starship/starship/blob/master/docs/zh-TW/guide/README.md" ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png" alt="繁體中文" /></a> -  + <a href="https://translate.starship.rs/project/starship-prompt/zh-CN" ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png" alt="简体中文" /></a> -  + <a href="https://translate.starship.rs/project/starship-prompt/de" ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png" alt="Deutsch" /></a> -  + <a href="https://translate.starship.rs/project/starship-prompt/fr" ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /></a> -  + <a href="https://translate.starship.rs/project/starship-prompt/ru" ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" alt="Русский" /></a> @@ -82,21 +82,18 @@ The prompt shows information you need while you're working, while staying sleek ## 🍬 Features - Prompt character turns red if the last command exits with non-zero code -- Current username if not the same as the logged-in user +- Current Go version (`🐹`) - Current Java version(`☕`) - Current Node.js version(`⬢`) -- Current Rust version (`🦀`) -- Current Ruby version (`💎`) -- Current Python version (`🐍`) - Current PHP version (`🐘`) -- Current Go version (`🐹`) -- Nix-shell environment detection -- Print an environment variable +- Current Python version (`🐍`) +- Current Ruby version (`💎`) +- Current Rust version (`🦀`) +- Current .NET version (`•NET`) - Current version of package in current directory (`📦`) - npm (Node.js) - cargo (Rust) - poetry (Python) -- Current battery level and status - Current Git branch and rich repo status: - `=` — conflicting changes - `⇡` — ahead of remote branch @@ -108,10 +105,19 @@ The prompt shows information you need while you're working, while staying sleek - `+` — added files - `»` — renamed files - `✘` — deleted files -- Execution time of the last command if it exceeds the set threshold +- Current Mercurial branch +- Current battery level and status +- `⇡` – charging +- `⇣` – discharging +- `•` – fully charged - Indicator for jobs in the background (`✦`) - Current Kubernetes Cluster and Namespace (`☸`) -- Current AWS profile (`☁️`) +- Current Amazon Web Services (AWS) profile (`☁️`) +- Execution time of the last command +- Custom environment variable value +- Nix-shell environment detection +- Current username if not the same as the logged-in user +- Optional current time in 12/24hr format ## 🚀 Installation @@ -123,48 +129,26 @@ The prompt shows information you need while you're working, while staying sleek 1. Install the **starship** binary: - **[Download archives of precompiled binaries](https://github.com/starship/starship/releases)** if you don't use the platforms below. + #### Install Latest Version - #### Homebrew + ##### With Shell: ```sh - $ brew install starship + curl -fsSL https://starship.rs/install.sh | sh ``` - #### Rust (v1.38 or higher) + #### Install via Package Manager - ```sh - $ cargo install starship - ``` - - #### Arch Linux (AUR) - - Starship is available on the AUR under the name `starship`. Install it with `yay` or your favorite AUR helper. + ##### With [Homebrew](https://brew.sh/): ```sh - $ yay -S starship + brew install starship ``` - #### Nix (unstable) + ##### With [Scoop](https://scoop.sh): - ```sh - $ nix-env --install starship - ``` - - #### Termux - - ```sh - $ pkg install starship - ``` - - #### Other x86-64 Linux Platforms - - Download a prebuilt binary and place in /usr/local/bin/ - - ```sh - $ wget -q --show-progress https://github.com/starship/starship/releases/latest/download/starship-x86_64-unknown-linux-gnu.tar.gz - $ tar xvf starship-x86_64-unknown-linux-gnu.tar.gz - $ sudo mv starship /usr/local/bin/ + ```powershell + scoop install starship ``` 1. Add the init script to your shell's config file: @@ -308,6 +292,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d <!-- markdownlint-enable --> <!-- prettier-ignore-end --> + <!-- ALL-CONTRIBUTORS-LIST:END --> This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |