From d901e262d0991362bb303816a578cfee2aeedbe3 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Wed, 12 Feb 2020 21:13:53 -0500 Subject: [PATCH] docs: rework the project README.md (#931) --- README.md | 212 +++++++----------------------------------------------- 1 file changed, 24 insertions(+), 188 deletions(-) diff --git a/README.md b/README.md index eff572d7..975e36f4 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,41 @@

-
Starship โ€“ Cross-shell prompt -

-

+

GitHub Actions workflow status Crates.io versionCrates.io version Packaging status
-
+ Chat on Discord - -All Contributors - + Contributors

-

-
+

Website ยท Installation ยท Configuration -

+

+

English -

-Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!
-The prompt shows information you need while you're working, while staying sleek and out of the way. -

+Starship with iTerm2 and the Snazzy theme + +**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** + + +- **Fast:** it's fast โ€“ _really really_ fast! ๐Ÿš€ +- **Customizable:** configure every aspect of your prompt. +- **Universal:** works on any shell, on any operating system. +- **Intelligent:** shows relevant information at a glance. +- **Feature rich:** support for all your favorite tools. +- **Easy:** quick to install โ€“ย start using it in minutes.

-
- Starship with iTerm2 and the Snazzy theme -
-
+
Explore the Starship docs  โ–ถ

-## ๐Ÿฌ Features - -- Prompt character turns red if the last command exits with non-zero code -- Current Elm version (`๐ŸŒณ`) -- Current Go version (`๐Ÿน`) -- Current Haskell version (`ฮป`) -- Current Java version(`โ˜•`) -- Current Node.js version(`โฌข`) -- Current PHP version (`๐Ÿ˜`) -- Current Python version (`๐Ÿ`) -- Current Ruby version (`๐Ÿ’Ž`) -- Current Rust version (`๐Ÿฆ€`) -- Current .NET version (`โ€ขNET`) -- Current Crystal version (`๐Ÿ”ฎ`). -- Current version of package in current directory (`๐Ÿ“ฆ`) - - npm (Node.js) - - cargo (Rust) - - poetry (Python) - - composer (PHP) -- Current Git branch and rich repo status: - - `=` โ€” conflicting changes - - `โ‡ก` โ€” ahead of remote branch - - `โ‡ฃ` โ€” behind of remote branch - - `โ‡•` โ€” diverged changes - - `?` โ€” untracked changes - - `$` โ€” stashed changes - - `!` โ€” modified files - - `+` โ€” added files - - `ยป` โ€” renamed files - - `โœ˜` โ€” deleted files -- Current Mercurial branch -- Current battery level and status - - `โ‡ก` โ€“ charging - - `โ‡ฃ` โ€“ discharging - - `โ€ข` โ€“ fully charged -- Indicator for jobs in the background (`โœฆ`) -- Current Kubernetes Cluster and Namespace (`โ˜ธ`) -- 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 -- Current Terraform Workspace and version (`๐Ÿ’ `) -- Current Conda environment (`C`) ## ๐Ÿš€ Installation @@ -206,8 +164,6 @@ The prompt shows information you need while you're working, while staying sleek 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) ``` @@ -221,132 +177,12 @@ The prompt shows information you need while you're working, while staying sleek eval $(starship init ion) ``` -## ๐Ÿ”ง Configuration - -For details on how to configure Starship, check out our [documentation](https://starship.rs/config/). - ## ๐Ÿค Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/๐ŸŒฑ%20good%20first%20issue). -### High Priority Needs - -- ๐Ÿ‘ฉโ€๐Ÿ’ผ **Product Manager** - - We have a GitHub Project and many unorganized/unprioritized features, as well as ideas that haven't yet been made into issues. Starship needs someone to own the product direction! -- ๐Ÿ‘ฉโ€๐ŸŽจ **Designer** - - Like making eye-catching websites? Excellent! We are looking to create a beautiful landing page showing off Starship in all its glory. Helping design for Starship's brand is a great opportunity to try out new ideas! -- ๐Ÿ‘ฉโ€๐Ÿ’ป **Rust Developer** - - There is _a lot_ of low-hanging fruit when it comes to writing idiomatic Rust, designing effective Rust architecture, performance optimizations, cross-platform build optimizations, and more! I ([@matchai](https://github.com/matchai)) am a beginner to Rust. Come point us in the right direction! - If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. ๐Ÿ‘‹ -### Contributors - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Matan Kushner

๐Ÿ’ป ๐ŸŽจ ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ‘€ โš ๏ธ

John Letey

๐Ÿ’ป ๐Ÿค” ๐Ÿ‘€ โš ๏ธ

Tim Mulqueen

๐Ÿ’ป ๐Ÿค” ๐Ÿ‘€ โš ๏ธ

Tiffany Le-Nguyen

๐Ÿค” ๐Ÿšง ๐Ÿ‘€ ๐Ÿ“–

โ€‹Snuggle

๐ŸŽจ ๐Ÿค” ๐Ÿšง ๐Ÿ‘€

Ryan Leckey

๐Ÿ‘€

Youssef Habri

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Kevin Song

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Andrew Dassonville

๐Ÿ› ๐Ÿ’ป

MaT1g3R

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Andrรฉ Zanellato

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Saghm Rossi

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Shu Kutsuzawa

๐Ÿ’ป ๐Ÿ“– โš ๏ธ ๐ŸŒ

Saurav Sharma

๐Ÿ’ป ๐Ÿ“–

Thomas O'Donnell

๐Ÿ’ป โš ๏ธ ๐Ÿ“– ๐Ÿ‘€

Bruno Bigras

๐Ÿ’ป ๐Ÿ‘€

Neil Kistner

๐Ÿ’ป โš ๏ธ ๐Ÿ‘€

Quinn Strahl

๐Ÿ’ป โš ๏ธ

Titouan Vervack

๐Ÿ’ป โš ๏ธ

Francisco Lopes

๐Ÿ’ป

Andrew Houts

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Nick Young

๐Ÿ’ป ๐Ÿ“– โš ๏ธ ๐Ÿ‘€

Gabriel de Perthuis

๐Ÿ’ป

Hofer-Julian

๐Ÿ“–

Yuji Ueki

๐Ÿ–‹ ๐ŸŒ

่ฐข็ฅฏๆ™–

๐Ÿ’ป ๐Ÿ“– ๐ŸŒ ๐Ÿ‘€

Kutsuzawa Ryo

๐Ÿ‘€ ๐Ÿ’ป โš ๏ธ ๐ŸŒ

hdevalke

๐Ÿค”

Kuba Clark

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Gimbar

๐Ÿ’ป โš ๏ธ ๐Ÿ“–

Tom Hotston

๐Ÿ’ป ๐Ÿ“–

Bijan Chokoufe Nejad

๐Ÿ’ป โš ๏ธ ๐Ÿ‘€

yuri

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

TsubasaKawajiri

๐ŸŒ

Ryo Yamashita

๐Ÿ’ป

Thomas Lee

๐Ÿ’ป

(ยดโŒฃ`สƒฦช)

๐Ÿ’ป

Barnaby Keene

๐Ÿ’ป

Keith Wade

๐Ÿ’ป โš ๏ธ

LukeAI

๐Ÿ“–

Zach Mertes

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

David Knaack

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Carl Summers

๐Ÿ“–

Yushan Lin

๐ŸŒ

Weihang Lo

๐ŸŒ

pinshan

๐ŸŒ

Brian Low

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Matias Kotlik

๐Ÿ’ป

marblenix

๐Ÿš‡ ๐Ÿ’ป โš ๏ธ

Raidou

๐Ÿ’ป โš ๏ธ

Luca Greco

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Luca Rinaldi

๐Ÿ’ป

Stephen Ball

๐Ÿ’ป โš ๏ธ ๐Ÿ“–

Qingping Hou

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Dan Wendorf

๐Ÿ’ป โš ๏ธ

Alan Pope

๐Ÿš‡

BuggStream

๐Ÿ’ป ๐Ÿ“–

Jon Grythe Stรธdle

๐Ÿ’ป โš ๏ธ

Jason Etcovitch

๐Ÿ›

Etienne Mabille

๐Ÿ’ป

AppleTheGolden

๐Ÿ’ป ๐Ÿ“–

Mike Sampson

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

Dominik Braun

๐Ÿ’ป

David Hewson

๐Ÿ’ป

Gennady Koshkin

๐ŸŒ

Oleksii Filonenko

๐ŸŒ

Artem Ivanov

๐ŸŒ

Peter Bull

๐Ÿ’ป โš ๏ธ

Andrew Prokhorenkov

๐Ÿ’ป ๐Ÿ“– โš ๏ธ

chirsz

๐ŸŒ
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! - ## ๐Ÿ’ญ Inspired By Please check out these previous works that helped inspire the creation of starship. ๐Ÿ™