sxyazi/yazi
1
1
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2024-12-20 07:11:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from g-plane/patch-1

Browse Source 
docs: update installation guide
This commit is contained in:
三咲雅 · Misaki Masa 2023-07-20 15:02:36 +08:00 committed by GitHub
commit df2930bdeb
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) - fzf (optional, for directory jumping)
- zoxide (optional, for directory jumping) - zoxide (optional, for directory jumping)
```bash ### Arch Linux
# Arch Linux
pacman -S ttf-nerd-fonts-symbols jq unarchiver ffmpegthumbnailer fd ripgrep fzf zoxide
# 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 install jq unar ffmpegthumbnailer fd ripgrep fzf zoxide
brew tap homebrew/cask-fonts && brew install --cask font-symbols-only-nerd-font 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: Execute the following commands to clone the project and build Yazi:
```bash ```bash
@ -36,12 +50,18 @@ cd yazi
cargo build --release cargo build --release
``` ```
## Usage Then, you can run:
```bash ```bash
./target/release/yazi ./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. 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 ## TODO