diff --git a/README.ja.md b/README.ja.md index c5b098db..b251dd0e 100644 --- a/README.ja.md +++ b/README.ja.md @@ -1,3 +1,190 @@ +

+
+ Starship โ€“ Cross-shell prompt +

+

+ + Crates.io version + + + Azure Pipelines Build Status + + + Packaging status +
+ + All Contributors + + + Chat on Discord + +

+

+
+ Website + ยท + Installation + ยท + Configuration +

+ +

+ +

+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 +
+
+

+ +## ๐Ÿฌ 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 Node.js version(`โฌข`) +- Current Rust version (`๐Ÿฆ€`) +- Current Ruby version (`๐Ÿ’Ž`) +- Current Python version (`๐Ÿ`) +- Current Go version (`๐Ÿน`) +- Nix-shell environment detection +- 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 + - `โ‡ฃ` โ€” behind of remote branch + - `โ‡•` โ€” diverged changes + - `?` โ€” untracked changes + - `$` โ€” stashed changes + - `!` โ€” modified files + - `+` โ€” added files + - `ยป` โ€” renamed files + - `โœ˜` โ€” deleted files +- Execution time of the last command if it exceeds the set threshold +- Indicator for jobs in the background (`โœฆ`) + +## ๐Ÿš€ Installation + +### Prerequisites + +- 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 + +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 + $ brew install starship + ``` + + #### Rust (v1.33 or higher) + + ```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. + + ```sh + $ yay -S starship + ``` + + #### Nix (unstable) + + ```sh + $ nix-env --install starship + ``` + + #### Termux + + ```sh + $ pkg install starship + ``` + +1. Add the init script to your shell's config file: + + #### Bash + + Add the following to the end of `~/.bashrc`: + + ```sh + # ~/.bashrc + + eval "$(starship init bash)" + ``` + + #### Fish + + Add the following to the end of `~/.config/fish/config.fish`: + + ```sh + # ~/.config/fish/config.fish + + eval (starship init fish) + ``` + + #### Zsh + + Add the following to the end of `~/.zshrc`: + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ``` + +## ๐Ÿ”ง 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)): + + + @@ -35,3 +222,27 @@
Matan Kushner
Matan Kushner

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

๐Ÿ‘€ ๐Ÿ’ป โš ๏ธ ๐ŸŒ
+ + + +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. ๐Ÿ™ + +- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts. + +- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - Cross-shell robbyrussell theme written in JavaScript. + +- **[reujab/silver](https://github.com/reujab/silver)** - A cross-shell customizable powerline-like prompt with icons. + +

+
+ Starship rocket icon +

+ +## ๐Ÿ“ License + +Copyright ยฉ 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
+This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.