summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShu Kutsuzawa <cappyzawa@yahoo.ne.jp>2019-09-19 00:43:59 +0900
committerMatan Kushner <hello@matchai.me>2019-09-18 11:43:59 -0400
commit095902626663c00d1e2b93b02c7bda1bc1200799 (patch)
treea6a731be1b976a20ad0d02d661317b1d006a23d0
parente64d103e7c95fe51ff148689425b41def460a6a5 (diff)
docs(i18n): Reset translation of README (#390)
-rw-r--r--README.ja.md211
1 files changed, 211 insertions, 0 deletions
diff --git a/README.ja.md b/README.ja.md
index c5b098db9..b251dd0eb 100644
--- a/README.ja.md
+++ b/README.ja.md
@@ -1,3 +1,190 @@
+<p align="center">
+ <br />
+ <img
+ width="400"
+ src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
+ alt="Starship โ€“ Cross-shell prompt"
+ />
+</p>
+<p align="center">
+ <a href="https://crates.io/crates/starship">
+ <img src="https://badgen.net/crates/v/starship" alt="Crates.io version" />
+ </a>
+ <a href="https://dev.azure.com/starship-control/starship/_build">
+ <img
+ src="https://badgen.net/azure-pipelines/starship-control/starship/Starship%20Test%20Suite"
+ alt="Azure Pipelines Build Status"
+ />
+ </a>
+ <a href="https://repology.org/project/starship/versions">
+ <img src="https://repology.org/badge/tiny-repos/starship.svg" alt="Packaging status">
+ </a><br>
+ <a href="#contributors">
+ <img
+ src="https://badgen.net/badge/all%20contributors/20/orange"
+ alt="All Contributors"
+ />
+ </a>
+ <a href="https://discord.gg/8Jzqu3T">
+ <img
+ src="https://badgen.net/badge/chat/on%20discord/7289da"
+ alt="Chat on Discord"
+ />
+ </a>
+</p>
+<h4 align="center">
+ <br />
+ <a href="https://starship.rs">Website</a>
+ ยท
+ <a href="#-installation">Installation</a>
+ ยท
+ <a href="https://starship.rs/config/">Configuration</a>
+</h4>
+
+<h1></h1>
+
+<p align="center">
+Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br>
+The prompt shows information you need while you're working, while staying sleek and out of the way.
+<p>
+
+<p align="center">
+ <br>
+ <img alt="Starship with iTerm2 and the Snazzy theme" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" width="80%">
+ <br>
+ <br>
+</p>
+
+## ๐Ÿฌ 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)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore -->
<table>
<tr>
<td align="center"><a href="https://twitter.com/matchai"><img src="https://avatars0.githubusercontent.com/u/4658208?v=4" width="100px;" alt="Matan Kushner"/><br /><sub><b>Matan Kushner</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=matchai" title="Code">๐Ÿ’ป</a> <a href="#design-matchai" title="Design">๐ŸŽจ</a> <a href="#ideas-matchai" title="Ideas, Planning, & Feedback">๐Ÿค”</a> <a href="#infra-matchai" title="Infrastructure (Hosting, Build-Tools, etc)">๐Ÿš‡</a> <a href="#maintenance-matchai" title="Maintenance">๐Ÿšง</a> <a href="#review-matchai" title="Reviewed Pull Requests">๐Ÿ‘€</a> <a href="https://github.com/starship/starship/commits?author=matchai" title="Tests">โš ๏ธ</a></td>
@@ -35,3 +222,27 @@
<td align="center"><a href="https://twitter.com/bookun2851"><img src="https://avatars2.githubusercontent.com/u/10346162?v=4" width="100px;" alt="Kutsuzawa Ryo"/><br /><sub><b>Kutsuzawa Ryo</b></sub></a><br /><a href="#review-bookun" title="Reviewed Pull Requests">๐Ÿ‘€</a> <a href="https://github.com/starship/starship/commits?author=bookun" title="Code">๐Ÿ’ป</a> <a href="https://github.com/starship/starship/commits?author=bookun" title="Tests">โš ๏ธ</a> <a href="#translation-bookun" title="Translation">๐ŸŒ</a></td>
</tr>
</table>
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+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.
+
+<p align="center">
+ <br>
+ <img width="100" src="media/icon.png" alt="Starship rocket icon">
+</p>
+
+## ๐Ÿ“ License
+
+Copyright ยฉ 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br>
+This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed.