pkgname: change to pay-respects

This commit is contained in:
iff 2023-08-05 03:22:05 +02:00
parent 9e17c0c68e
commit 91adbac64f
2 changed files with 10 additions and 10 deletions

View file

@ -1,5 +1,5 @@
[package] [package]
name = "pay_respects" name = "pay-respects"
version = "0.4.0" version = "0.4.0"
edition = "2021" edition = "2021"

View file

@ -18,19 +18,19 @@ The binary is named `pay-respects`, by adding an alias to your shell
configuration: configuration:
``` shell ``` shell
# Note: You may need to have the binary exposed in your path # Note: You may need to have the binary exposed in your path
alias f="$(pay_respects <your_shell_here>)" alias f="$(pay-respects <your_shell_here>)"
# for example, using `zsh`: # for example, using `zsh`:
alias f="$(pay_respects zsh)" alias f="$(pay-respects zsh)"
# Alternatively, you can also use the following initialization in your config file # Alternatively, you can also use the following initialization in your config file
# for bash and zsh # for bash and zsh
eval "$(pay_respects <shell> --alias)" eval "$(pay-respects <shell> --alias)"
# for fish # for fish
pay_respects fish --alias | source pay-respects fish --alias | source
# for `nushell`, the alias can be added automatically with: # for `nushell`, the alias can be added automatically with:
pay_respects nushell pay-respects nushell
``` ```
You can now **press `F` to Pay Respects**! You can now **press `F` to Pay Respects**!
@ -38,23 +38,23 @@ Currently, only corrections to `bash`, `zsh`, and `fish` are working flawlessly.
`nushell` has broken aliases, therefore it has following 2 limitations: `nushell` has broken aliases, therefore it has following 2 limitations:
- You have to manually add the output of `pay_respects nushell` to your configuration as alias - You have to manually add the output of `pay-respects nushell` to your configuration as alias
- Aliased commands cannot be expanded to their original command - Aliased commands cannot be expanded to their original command
## Installing ## Installing
If you are using Arch Linux, you can install from AUR directly: If you are using Arch Linux, you can install from AUR directly:
```shell ```shell
paru -S pay_respects paru -S pay-respects
``` ```
Alternatively, you can download Linux binary from [releases](https://github.com/iffse/pay_respects/releases). Alternatively, you can download Linux binary from [releases](https://github.com/iffse/pay-respects/releases).
Otherwise, you can use cargo to compile the project: Otherwise, you can use cargo to compile the project:
``` ```
cargo build --release cargo build --release
``` ```
and the binary can be found at `target/release/pay_respects`. and the binary can be found at `target/release/pay-respects`.
## Rule Files ## Rule Files