From e078bf472722e604783fa293d7b7e629b0bad0d0 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Tue, 17 Dec 2019 16:46:43 -0500 Subject: [PATCH] docs: Make website docs consistent with README.md --- README.md | 4 +++- docs/README.md | 43 +++++++++++++++++++++---------------------- 2 files changed, 24 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index a157b654..ebf2dab9 100644 --- a/README.md +++ b/README.md @@ -186,12 +186,13 @@ The prompt shows information you need while you're working, while staying sleek eval "$(starship init zsh)" ``` - #### Powershell + #### PowerShell Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix): ```sh # ~\Documents\PowerShell\Profile.ps1 + Invoke-Expression (&starship init powershell) ``` @@ -313,6 +314,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d + This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/docs/README.md b/docs/README.md index dbe1ad60..fdecab04 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,38 +32,26 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors 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 | bash ``` - #### Rust (v1.38 or higher) + #### Install via Package Manager + + ##### With [Homebrew](https://brew.sh/): ```sh - $ cargo install starship + brew install starship ``` - #### Arch Linux (AUR) + ##### With [Scoop](https://scoop.sh): - Starship is available on the AUR under the name `starship`. Install it with `yay` or your favorite AUR helper. - - ```sh - $ yay -S starship - ``` - - #### Nix (unstable) - - ```sh - $ nix-env --install starship - ``` - - #### Termux - - ```sh - $ pkg install starship + ```powershell + scoop install starship ``` 1. Add the init script to your shell's config file: @@ -104,5 +92,16 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors ```sh # ~\Documents\PowerShell\Profile.ps1 + Invoke-Expression (&starship init powershell) ``` + + #### Ion + + Add the following to the end of `~/.config/ion/initrc`: + + ```sh + # ~/.config/ion/initrc + + eval $(starship init ion) + ```