1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2025-04-10 10:51:51 +00:00

docs: Add Brew installation instructions (#136)

This commit is contained in:
Matan Kushner 2019-08-10 19:22:28 -04:00 committed by GitHub
parent 5bcbedbabb
commit 53f8ed1cd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -52,15 +52,24 @@ The prompt shows information need while you're working, while staying sleek and
### Prerequisites ### Prerequisites
- [Rust](https://rustup.rs/) v1.33 or higher
- A [Powerline font](https://github.com/powerline/fonts) installed and enabled in your terminal (for example, try [Fira Code](https://github.com/tonsky/FiraCode)). - A [Powerline font](https://github.com/powerline/fonts) installed and enabled in your terminal (for example, try [Fira Code](https://github.com/tonsky/FiraCode)).
### Getting Started ### Getting Started
1. Install the **starship** binary: 1. Install the **starship** binary:
**[Download archives of precompiled binaries](https://github.com/starship/starship/releases)** if you don't use the platforms below.
#### Homebrew
```sh ```sh
cargo install starship $ brew install starship
```
#### Rust (v1.33 or higher)
```sh
$ cargo install starship
``` ```
1. Add the init script to your shell's config file: 1. Add the init script to your shell's config file:
@ -105,6 +114,7 @@ We are always looking for contributors of **all skill levels**! If you're lookin
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](./CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](./CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
### Contributors ### Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->