From 896c4496065c4f6290537135168e9a2f8f753b0f Mon Sep 17 00:00:00 2001 From: Chase C <13863948+ChaseCares@users.noreply.github.com> Date: Sat, 6 May 2023 08:09:04 -0400 Subject: [PATCH 1/5] fix aur name --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a7c858d..4f44671 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ## Installation - You can install the latest release from [crates.io][crates.io] using `cargo install cmus-notify` - You can also install the latest version from the git repository using `cargo install --git https://github.com/anas-elgarhy/cmus-notify` -- Or if you use Arch Linux, you can install the [AUR package][aur package] using your favorite AUR helper. e.g. `yay -S notify-cmus` +- Or if you use Arch Linux, you can install the [AUR package][aur package] using your favorite AUR helper. e.g. `yay -S cmus-notify` ## Usage - Run `cmus-notify` in your terminal to start the program, the program will run in the background and will notify you about cmus status changes @@ -35,6 +35,6 @@ [repo]: https://github.com/anas-elgarhy/cmus-notify [crates.io]: https://crates.io/crates/cmus-notify -[aur package]: https://aur.archlinux.org/packages/notify-cmus/ +[aur package]: https://aur.archlinux.org/packages/cmus-notify/ [just]: https://github.com/casey/just [grcov]:https://github.com/mozilla/grcov From 77aa676d75dd93e9aa3d9b454307b827ee61be95 Mon Sep 17 00:00:00 2001 From: Chase C <13863948+ChaseCares@users.noreply.github.com> Date: Sat, 6 May 2023 08:09:31 -0400 Subject: [PATCH 2/5] fix whitespace --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4f44671..d0d5586 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,4 @@ [crates.io]: https://crates.io/crates/cmus-notify [aur package]: https://aur.archlinux.org/packages/cmus-notify/ [just]: https://github.com/casey/just -[grcov]:https://github.com/mozilla/grcov +[grcov]: https://github.com/mozilla/grcov From 7aa3f5cf180a7cc97eb919f6795cab5a008d7bab Mon Sep 17 00:00:00 2001 From: Chase C <13863948+ChaseCares@users.noreply.github.com> Date: Sat, 6 May 2023 08:11:43 -0400 Subject: [PATCH 3/5] optional: comply with md lint MD022 --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0d5586..26e907e 100644 --- a/README.md +++ b/README.md @@ -7,21 +7,25 @@ > **Note:** This project is still in its early stages and is not yet ready for production use. It is currently being developed as a just-for-fun project. If you are interested in contributing, please feel free to open an issue or a pull request. ## Installation + - You can install the latest release from [crates.io][crates.io] using `cargo install cmus-notify` - You can also install the latest version from the git repository using `cargo install --git https://github.com/anas-elgarhy/cmus-notify` - Or if you use Arch Linux, you can install the [AUR package][aur package] using your favorite AUR helper. e.g. `yay -S cmus-notify` ## Usage + - Run `cmus-notify` in your terminal to start the program, the program will run in the background and will notify you about cmus status changes - You can also run `cmus-notify --help` to see the available options, also you can see the available options in the [usage](./docs/usage.md) - You also have the ability to configure the program using a configuration file, you basically have the same options as the command line arguments, but you can also use the configuration file to set the default values for the command line arguments, the default configuration file path is `~/.config/cmus-notify/config.toml`, you can also use the `--config` option to specify a custom configuration file path, the default config file will be created in `~/.config/cmus-notify/config.toml` if it doesn't exist - The recommended way to use the program is to run it in the background when you start the `cmus` music player, you can do that by creating an alias for `cmus` in your shell configuration file, e.g. `alias cmus="cmus-notify --link & cmus"`, the `--link` option will link the `cmus-notify` process to the `cmus` process, so when you close `cmus` the `cmus-notify` process will also be terminated ## Development + - This project is written in Rust, so you need to have Rust installed on your system, you can install Rust using [rustup](https://rustup.rs/) - This project, like most Rust projects, uses `cargo` as the build system. But to make my life easier I decided to use [just][just] as a task runner, so you need to install `just` using `cargo install just` ### Just tasks + - To build the project, run `just build` in the debug mode with all the features enabled - To build the project in the release mode, run `just build--release` with all the features enabled - To build and run the project, run `just run`, this will build the project in the debug mode and run it with the debug log level @@ -32,7 +36,6 @@ > You can see the all the available tasks and aliases in the [justfile](./justfile), or by running `just --list` - [repo]: https://github.com/anas-elgarhy/cmus-notify [crates.io]: https://crates.io/crates/cmus-notify [aur package]: https://aur.archlinux.org/packages/cmus-notify/ From 7ec7b56a29c894980d426619a0a85bdaba7510ed Mon Sep 17 00:00:00 2001 From: Chase C <13863948+ChaseCares@users.noreply.github.com> Date: Sat, 6 May 2023 08:12:12 -0400 Subject: [PATCH 4/5] optional: remove unnecessary link --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 26e907e..244fa7f 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,6 @@ > You can see the all the available tasks and aliases in the [justfile](./justfile), or by running `just --list` -[repo]: https://github.com/anas-elgarhy/cmus-notify [crates.io]: https://crates.io/crates/cmus-notify [aur package]: https://aur.archlinux.org/packages/cmus-notify/ [just]: https://github.com/casey/just From 7d23b6568459b5964ca02610ec13b3ec1f33446e Mon Sep 17 00:00:00 2001 From: Chase C <13863948+ChaseCares@users.noreply.github.com> Date: Sat, 6 May 2023 12:11:09 -0400 Subject: [PATCH 5/5] Revert "fix aur name" This reverts commit 896c4496065c4f6290537135168e9a2f8f753b0f. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 244fa7f..5ebd89e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ - You can install the latest release from [crates.io][crates.io] using `cargo install cmus-notify` - You can also install the latest version from the git repository using `cargo install --git https://github.com/anas-elgarhy/cmus-notify` -- Or if you use Arch Linux, you can install the [AUR package][aur package] using your favorite AUR helper. e.g. `yay -S cmus-notify` +- Or if you use Arch Linux, you can install the [AUR package][aur package] using your favorite AUR helper. e.g. `yay -S notify-cmus` ## Usage @@ -37,6 +37,6 @@ > You can see the all the available tasks and aliases in the [justfile](./justfile), or by running `just --list` [crates.io]: https://crates.io/crates/cmus-notify -[aur package]: https://aur.archlinux.org/packages/cmus-notify/ +[aur package]: https://aur.archlinux.org/packages/notify-cmus/ [just]: https://github.com/casey/just [grcov]: https://github.com/mozilla/grcov