Skip to content

Commit 188e915

Browse files
committed
docs: clarify configuration file creation in README
1 parent 4da368b commit 188e915

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,16 @@ perfdeck
8080

8181
## ⚙️ Configuration
8282

83-
Perfdeck is designed to be personalized. It looks for `perfdeck.toml` in:
84-
1. `$PERFDECK_CONFIG`
83+
Perfdeck is designed to be personalized. To create your own configuration, create a file named `perfdeck.toml` in one of the following locations (searched in this order):
84+
85+
1. `$PERFDECK_CONFIG` (full path to the file)
8586
2. `~/.config/perfdeck/config.toml`
86-
3. Current working directory
87+
3. The current directory (`./perfdeck.toml`)
88+
89+
### 📝 Example `perfdeck.toml`
90+
91+
Create the file with your favorite editor and add the following content to customize your tabs and refresh intervals:
8792

88-
### 📝 Configuration Schema
8993
```toml
9094
# Interval for updating the sparklines and default tabs
9195
global_refresh_interval = "5s"

0 commit comments

Comments
 (0)