Skip to content

Commit

Permalink
docs: add instructions for installing yazi from source (#211)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikavilpas authored Jul 16, 2024
1 parent 532990d commit 377a68a
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ First, make sure you have the requirements:

- Neovim 0.10.x or later
- yazi [0.2.5](https://github.com/sxyazi/yazi/releases/tag/v0.2.5) or later
- If you want to opt in to using the latest version of yazi, see
[here](./documentation/installing-yazi-from-source.md) for how to install it
from source

> [!TIP]
>
Expand Down
47 changes: 47 additions & 0 deletions documentation/installing-yazi-from-source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Installing yazi from source

> This document explains how to install the latest version of yazi from source.
> If you're looking for a way to install an unreleased version of yazi.nvim, see
> [the instructions for developers](./for-developers/developing.md).
Yazi is moving fast, and some new yazi.nvim features might be supported only for
the latest version of yazi.

If you need the latest version of yazi, you can install it from source. This is
useful if you want to try out the latest features or if you want to contribute
to the project.

> [!NOTE]
>
> Keep in mind that installing from source might be more complex than installing
> from a release. That being said, many yazi.nvim users run the latest version
> of yazi from source without any issues.
1. Install [rustup](https://rustup.rs/), which installs the Rust toolchain. Yazi
is written in rust, so you need this to compile and install it.
- if you have another way of installing the Rust toolchain, you can skip this
step.
2. Clone the [yazi repository](https://github.com/sxyazi/yazi/) with git and
navigate to it.
3. Execute these commands to build+install yazi:

```sh
# in the yazi repository:

# Install `yazi`, the main application
cargo install --path yazi-fm

# Install `ya`, the command line interface that's internally used by yazi.nvim
cargo install --path yazi-cli
```

4. In case there are any issues, you can try these steps:

- Check <https://yazi-rs.github.io/docs/installation/> and see if you have
followed all steps correctly
- Yazi has a `yazi --debug` command that can help you debug issues specific to
yazi
- In yazi.nvim, you can run `:checkhealth yazi` to see if everything works

5. If you still have issues, please open an issue:
<https://github.com/mikavilpas/yazi.nvim/issues>

0 comments on commit 377a68a

Please sign in to comment.