mroot/yazi
1
0
Fork 0
mirror of https://github.com/sxyazi/yazi.git synced 2026-07-25 08:41:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: add official Nix package

Browse source
This commit is contained in:
sxyazi 2023-08-28 16:57:52 +08:00
parent a36dabfe85
commit 04ff62c46c
No known key found for this signature in database
1 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -63,10 +63,14 @@ cargo install --git https://github.com/sxyazi/yazi.git
<summary>Nix</summary> <summary>Nix</summary>
Nix users can install Yazi from [the NUR](https://github.com/nix-community/nur-combined/blob/master/repos/xyenon/pkgs/yazi/default.nix): The [Nix package of Yazi](https://search.nixos.org/packages?channel=unstable&show=yazi) is available. Nix users can install Yazi via:
```bash ```bash
nix-env -iA nur.repos.xyenon.yazi # On NixOS:
nix-env -iA nixos.yazi
# On Non NixOS:
nix-env -iA nixpkgs.yazi
``` ```
Or add the following to your configuration: Or add the following to your configuration:
@ -74,11 +78,12 @@ Or add the following to your configuration:
```nix ```nix
# configuration.nix # configuration.nix
environment.systemPackages = with pkgs; [ environment.systemPackages = with pkgs; [
nur.repos.xyenon.yazi yazi
]; ];
``` ```
If you prefer to use the most recent code, use `nur.repos.xyenon.yazi-unstable` instead. You can also manage Yazi's configuration using the
[home-manager](https://nix-community.github.io/home-manager/options.html#opt-programs.yazi.enable).
</details> </details>
@ -108,8 +113,6 @@ Then, you can run:
yazi yazi
``` ```
If you want to use your own config, copy the [config folder](https://github.com/sxyazi/yazi/tree/main/config/preset) to `~/.config/yazi`, and modify it as you like.
There is a wrapper of yazi, that provides the ability to change the current working directory when yazi exiting, feel free to use it: There is a wrapper of yazi, that provides the ability to change the current working directory when yazi exiting, feel free to use it:
```bash ```bash
@ -123,6 +126,12 @@ function ya() {
} }
``` ```
## Configuration
If you want to use your own config, copy the [config folder](./config/preset) to `~/.config/yazi`, and modify it as you like.
[The documentation of all available options](./config/docs)
## Discussion ## Discussion
- Discord Server (English mainly): https://discord.gg/qfADduSdJu - Discord Server (English mainly): https://discord.gg/qfADduSdJu