summaryrefslogtreecommitdiffstats
path: root/docs/zh/README.md
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2019-10-04 17:57:43 +0900
committerGitHub <noreply@github.com>2019-10-04 17:57:43 +0900
commitabcea4b3d93895a947e0eadcc4d41227b96f7427 (patch)
tree1a5afeb331c18e494ccb8e5b722bac22ac744589 /docs/zh/README.md
parent7fc85669bb45a032e9e837771b21a949a6f33bd3 (diff)
docs(i18n): Update Crowdin translations (#441)
Diffstat (limited to 'docs/zh/README.md')
-rw-r--r--docs/zh/README.md107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/zh/README.md b/docs/zh/README.md
new file mode 100644
index 000000000..7cd8a78c5
--- /dev/null
+++ b/docs/zh/README.md
@@ -0,0 +1,107 @@
+---
+home: true
+heroImage: /logo.svg
+actionText: Get Started →
+actionLink: /guide/
+footer: ISC Licensed | Copyright © 2019-present Starship Contributors
+---
+
+<div class="features">
+ <div class="feature">
+ <h2>Compatibility First</h2>
+ <p>Works on the most common shells on the most common operating systems. Use it everywhere!</p>
+ </div>
+ <div class="feature">
+ <h2>Rust-Powered</h2>
+ <p>Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.</p>
+ </div>
+ <div class="feature">
+ <h2>Customizable</h2>
+ <p>Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.</p>
+ </div>
+</div>
+
+<div class="center">
+ <video class="demo-video" autoplay muted loop>
+ <source src="/demo.webm" type="video/webm">
+ <source src="/demo.mp4" type="video/mp4">
+ </video>
+</div>
+
+### Quick Install
+
+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)"
+ ```