From ba130093218c3a6ec95157be0aa71b670074e4d5 Mon Sep 17 00:00:00 2001 From: Pig Fang Date: Thu, 20 Jul 2023 14:12:37 +0800 Subject: [PATCH] docs: update installation guide --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9d323a44..efa9901f 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,29 @@ Before getting started, ensure that the following dependencies are installed on - fzf (optional, for directory jumping) - zoxide (optional, for directory jumping) -```bash -# Arch Linux -pacman -S ttf-nerd-fonts-symbols jq unarchiver ffmpegthumbnailer fd ripgrep fzf zoxide +### Arch Linux -# macOS +Install with paru or your favorite AUR helper: + +```bash +paru -S yazi jq unarchiver ffmpegthumbnailer fd ripgrep fzf zoxide +``` + +### macOS + +```bash brew install jq unar ffmpegthumbnailer fd ripgrep fzf zoxide brew tap homebrew/cask-fonts && brew install --cask font-symbols-only-nerd-font ``` +### Cargo + +```bash +cargo install --git https://github.com/sxyazi/yazi.git +``` + +### Build from source + Execute the following commands to clone the project and build Yazi: ```bash @@ -36,12 +50,18 @@ cd yazi cargo build --release ``` -## Usage +Then, you can run: ```bash ./target/release/yazi ``` +## Usage + +```bash +yazi +``` + If you want to use your own config, copy the [config folder](https://github.com/sxyazi/yazi/tree/main/config) to `~/.config/yazi`, and modify it as you like. ## TODO