docs: Improve README usage instructions #7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nullishamy
reviewed
Feb 26, 2024
| 2. Copy the contents of _flavour_.cava into your Cava config file, as specified in [Cava's README](https://github.com/karlstav/cava#configuration). Typically, the config file is located at: `~/.config/cava/`. Ensure you replace the existing gradient settings. | ||
|
|
||
| > [!WARNING] | ||
| > Running any of the commands below may overwrite your existing cava configuration file. |
There was a problem hiding this comment.
Might be worth noting that this won't override the primary cava config, but will instead put the port colours alongside it.
| @@ -18,9 +18,43 @@ | |||
| ## Usage | |||
|
|
|||
| 1. Choose your flavour. | |||
| 2. Copy the contents of _flavour_.cava into your Cava config file (usually located at: `$HOME/.config/cava/`), replacing the existing gradient settings. | |||
| 2. Copy the contents of _flavour_.cava into your Cava config file, as specified in [Cava's README](https://github.com/karlstav/cava#configuration). Typically, the config file is located at: `~/.config/cava/`. Ensure you replace the existing gradient settings. | |||
There was a problem hiding this comment.
According to the Cava docs, the file is located at ~/.config/cava/config, rather than ~/.config/cava. We should be specific.
|
|
||
| > [!WARNING] | ||
| > Running any of the commands below may overwrite your existing cava configuration file. | ||
|
|
There was a problem hiding this comment.
Would it be better to provide a cURL example instead? Is it more commonly installed OOTB than wget?
| ```sh | ||
| wget -O ~/.config/cava/config https://github.com/catppuccin/cava/raw/main/mocha.cava | ||
| ``` | ||
|
|
||
| 3. Reload cava if it was already playing. |
There was a problem hiding this comment.
According to the Cava docs, you can reload Cava without restarting by sending it SIGUSR1 :
$ pkill -USR1 cavaIs it worth noting this?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.