Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update installation guide #1

Merged
merged 1 commit into from
Jul 20, 2023
Merged

docs: update installation guide #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

### Arch Linux

Install with paru or your favorite AUR helper:

```bash
# Arch Linux
pacman -S ttf-nerd-fonts-symbols jq unarchiver ffmpegthumbnailer fd ripgrep fzf zoxide
paru -S yazi jq unarchiver ffmpegthumbnailer fd ripgrep fzf zoxide
```

### macOS

# 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
Expand All @@ -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
Expand Down