Skip to content

docs: Improve README usage instructions #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ioulan wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Improve README usage instructions #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

@nullishamy nullishamy Feb 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

@nullishamy nullishamy Feb 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth noting that this won't override the primary cava config, but will instead put the port colours alongside it.


Copy link
Member

@nullishamy nullishamy Feb 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better to provide a cURL example instead? Is it more commonly installed OOTB than wget?

- Latte
```sh
wget -O ~/.config/cava/config https://github.com/catppuccin/cava/raw/main/latte.cava
```

- Frappé
```sh
wget -O ~/.config/cava/config https://github.com/catppuccin/cava/raw/main/frappe.cava
```

- Macchiato
```sh
wget -O ~/.config/cava/config https://github.com/catppuccin/cava/raw/main/macchiato.cava
```

- Mocha
```sh
wget -O ~/.config/cava/config https://github.com/catppuccin/cava/raw/main/mocha.cava
```

3. Reload cava if it was already playing.
Copy link
Member

@nullishamy nullishamy Feb 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the Cava docs, you can reload Cava without restarting by sending it SIGUSR1 :

$ pkill -USR1 cava

Is it worth noting this?


## 🙋 FAQ

- Q: **_"Error loading config. Only 'ncurses' output method supports HTML colors. "_**\
A: As of version 0.7.0, ncurses is no longer the default output method. Adjust this in your config file.

```ini
[output]
method = ncurses
```

## 💝 Thanks to

- [Pocco81](https://github.com/Pocco81)
Expand Down