mroot/yazi
1
0
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2026-07-21 23:01:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: update installation guide

Browse source
This commit is contained in:
Pig Fang 2023-07-20 14:12:37 +08:00 • committed by GitHub
parent ed53ea6efb
commit ba13009321
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

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